karrio-allied-express 2025.5rc1__py3-none-any.whl

karrio/mappers/allied_express/__init__.py

@@ -0,0 +1,3 @@
+from karrio.mappers.allied_express.mapper import Mapper
+from karrio.mappers.allied_express.proxy import Proxy
+from karrio.mappers.allied_express.settings import Settings

karrio/mappers/allied_express/mapper.py

@@ -0,0 +1,55 @@
+
+"""Karrio Allied Express client mapper."""
+
+import typing
+import karrio.lib as lib
+import karrio.api.mapper as mapper
+import karrio.core.models as models
+import karrio.providers.allied_express as provider
+import karrio.mappers.allied_express.settings as provider_settings
+
+
+class Mapper(mapper.Mapper):
+    settings: provider_settings.Settings
+
+    def create_rate_request(
+        self, payload: models.RateRequest
+    ) -> lib.Serializable:
+        return provider.rate_request(payload, self.settings)
+    
+    def create_tracking_request(
+        self, payload: models.TrackingRequest
+    ) -> lib.Serializable:
+        return provider.tracking_request(payload, self.settings)
+    
+    def create_shipment_request(
+        self, payload: models.ShipmentRequest
+    ) -> lib.Serializable:
+        return provider.shipment_request(payload, self.settings)
+    
+    def create_cancel_shipment_request(
+        self, payload: models.ShipmentCancelRequest
+    ) -> lib.Serializable[str]:
+        return provider.shipment_cancel_request(payload, self.settings)
+    
+    
+    def parse_cancel_shipment_response(
+        self, response: lib.Deserializable[str]
+    ) -> typing.Tuple[models.ConfirmationDetails, typing.List[models.Message]]:
+        return provider.parse_shipment_cancel_response(response, self.settings)
+    
+    def parse_rate_response(
+        self, response: lib.Deserializable[str]
+    ) -> typing.Tuple[typing.List[models.RateDetails], typing.List[models.Message]]:
+        return provider.parse_rate_response(response, self.settings)
+    
+    def parse_shipment_response(
+        self, response: lib.Deserializable[str]
+    ) -> typing.Tuple[models.ShipmentDetails, typing.List[models.Message]]:
+        return provider.parse_shipment_response(response, self.settings)
+    
+    def parse_tracking_response(
+        self, response: lib.Deserializable[str]
+    ) -> typing.Tuple[typing.List[models.TrackingDetails], typing.List[models.Message]]:
+        return provider.parse_tracking_response(response, self.settings)
+    

karrio/mappers/allied_express/proxy.py

@@ -0,0 +1,74 @@
+"""Karrio Allied Express client proxy."""
+
+import karrio.lib as lib
+import karrio.api.proxy as proxy
+import karrio.providers.allied_express.utils as provider_utils
+import karrio.mappers.allied_express.settings as provider_settings
+
+
+class Proxy(proxy.Proxy):
+    settings: provider_settings.Settings
+
+    def get_rates(self, request: lib.Serializable) -> lib.Deserializable[str]:
+        response = lib.request(
+            url=f"{self.settings.server_url}/calculatePrice",
+            data=request.serialize(),
+            trace=self.trace_as("json"),
+            method="POST",
+            headers={
+                "Authorization": f"Basic {self.settings.authorization}",
+                "Content-Type": "application/json",
+            },
+        )
+
+        return lib.Deserializable(response, provider_utils.parse_response, request.ctx)
+
+    def create_shipment(self, request: lib.Serializable) -> lib.Deserializable[str]:
+        response = lib.request(
+            url=f"{self.settings.server_url}/GetLabelfull",
+            data=request.serialize(),
+            trace=self.trace_as("json"),
+            method="POST",
+            headers={
+                "Authorization": f"Basic {self.settings.authorization}",
+                "Content-Type": "application/json",
+            },
+        )
+
+        return lib.Deserializable(response, provider_utils.parse_response, request.ctx)
+
+    def cancel_shipment(self, request: lib.Serializable) -> lib.Deserializable[str]:
+        payload = request.serialize()
+        response = lib.request(
+            url=f"{self.settings.server_url}/cancelJob/{payload['shipmentno']}/{payload['postalcode']}",
+            trace=self.trace_as("json"),
+            method="POST",
+            headers={
+                "Authorization": f"Basic {self.settings.authorization}",
+                "Content-Type": "application/json",
+            },
+        )
+
+        return lib.Deserializable(response, provider_utils.parse_response)
+
+    def get_tracking(self, request: lib.Serializable) -> lib.Deserializable[str]:
+        response = lib.run_asynchronously(
+            lambda payload: (
+                payload["shipmentno"],
+                lib.request(
+                    url=f"{self.settings.server_url}/getShipmentsStatus/{payload['shipmentno']}",
+                    trace=self.trace_as("json"),
+                    method="POST",
+                    headers={
+                        "Authorization": f"Basic {self.settings.authorization}",
+                        "Content-Type": "application/json",
+                    },
+                ),
+            ),
+            request.serialize(),
+        )
+
+        return lib.Deserializable(
+            response,
+            lambda __: [(no, provider_utils.parse_response(_)) for no, _ in __],
+        )

karrio/mappers/allied_express/settings.py

@@ -0,0 +1,23 @@
+"""Karrio Allied Express client settings."""
+
+import attr
+import karrio.providers.allied_express.utils as utils
+
+
+@attr.s(auto_attribs=True)
+class Settings(utils.Settings):
+    """Allied Express connection settings."""
+
+    # required carrier specific properties
+    username: str
+    password: str
+    account: str = None
+    service_type: utils.AlliedServiceType = "R"  # type: ignore
+
+    # generic properties
+    id: str = None
+    test_mode: bool = False
+    carrier_id: str = "allied_express"
+    account_country_code: str = "AU"
+    metadata: dict = {}
+    config: dict = {}

karrio/plugins/allied_express/__init__.py

@@ -0,0 +1,20 @@
+import karrio.core.metadata as metadata
+import karrio.mappers.allied_express as mappers
+import karrio.providers.allied_express.units as units
+import karrio.providers.allied_express.utils as utils
+
+
+METADATA = metadata.PluginMetadata(
+    status="beta",
+    id="allied_express",
+    label="Allied Express",
+    # Integrations
+    Mapper=mappers.Mapper,
+    Proxy=mappers.Proxy,
+    Settings=mappers.Settings,
+    # Data Units
+    is_hub=False,
+    services=units.ShippingService,
+    options=units.ShippingOption,
+    connection_configs=utils.ConnectionConfig,
+)

karrio/providers/allied_express/__init__.py

@@ -0,0 +1,13 @@
+
+from karrio.providers.allied_express.utils import Settings
+from karrio.providers.allied_express.rate import parse_rate_response, rate_request
+from karrio.providers.allied_express.shipment import (
+    parse_shipment_cancel_response,
+    parse_shipment_response,
+    shipment_cancel_request,
+    shipment_request,
+)
+from karrio.providers.allied_express.tracking import (
+    parse_tracking_response,
+    tracking_request,
+)

karrio/providers/allied_express/error.py

@@ -0,0 +1,34 @@
+import typing
+import karrio.core.models as models
+import karrio.providers.allied_express.utils as provider_utils
+
+
+def parse_error_response(
+    response: provider_utils.AlliedResponse,
+    settings: provider_utils.Settings,
+    **kwargs,
+) -> typing.List[models.Message]:
+    errors = []
+
+    if response.error is not None:
+        errors.append(["500", response.error])
+
+    if response.is_error and response.data is not None:
+        errors.append(
+            [
+                "400",
+                response.data["result"].get("statusError")
+                or response.data["result"].get("errors"),
+            ]
+        )
+
+    return [
+        models.Message(
+            carrier_id=settings.carrier_id,
+            carrier_name=settings.carrier_name,
+            code=code,
+            message=message,
+            details={**kwargs},
+        )
+        for code, message in errors
+    ]

karrio/providers/allied_express/rate.py

@@ -0,0 +1,147 @@
+import karrio.schemas.allied_express.rate_request as allied
+import karrio.schemas.allied_express.rate_response as rating
+import typing
+import karrio.lib as lib
+import karrio.core.units as units
+import karrio.core.models as models
+import karrio.providers.allied_express.error as error
+import karrio.providers.allied_express.utils as provider_utils
+import karrio.providers.allied_express.units as provider_units
+
+
+def parse_rate_response(
+    _response: lib.Deserializable[provider_utils.AlliedResponse],
+    settings: provider_utils.Settings,
+) -> typing.Tuple[typing.List[models.RateDetails], typing.List[models.Message]]:
+    response = _response.deserialize()
+
+    messages = error.parse_error_response(response, settings)
+    rates = [
+        _extract_details(rate.data["result"], settings, _response.ctx)
+        for rate in [response]
+        if not rate.is_error and "result" in (rate.data or {})
+    ]
+
+    return rates, messages
+
+
+def _extract_details(
+    data: dict,
+    settings: provider_utils.Settings,
+    ctx: dict,
+) -> models.RateDetails:
+    rate = lib.to_object(rating.ResultType, data)
+    service = provider_units.ShippingService.map(
+        ctx.get("service")
+        or settings.connection_config.account_service_type.state
+        or settings.service_type
+        or "R"
+    )
+    charges = [
+        ("Job charge", lib.to_money(rate.jobCharge)),
+        *((s.chargeCode, lib.to_money(s.netValue)) for s in rate.surcharges),
+    ]
+
+    return models.RateDetails(
+        carrier_id=settings.carrier_id,
+        carrier_name=settings.carrier_name,
+        service=service.name_or_key,
+        total_charge=lib.to_money(rate.totalCharge),
+        currency=units.Currency.AUD.name,
+        extra_charges=[
+            models.ChargeDetails(
+                name=name,
+                amount=amount,
+                currency=units.Currency.AUD.name,
+            )
+            for name, amount in charges
+            if amount > 0
+        ],
+        meta=dict(
+            service_name=service.name,
+        ),
+    )
+
+
+def rate_request(
+    payload: models.RateRequest,
+    settings: provider_utils.Settings,
+) -> lib.Serializable:
+    shipper = lib.to_address(payload.shipper)
+    recipient = lib.to_address(payload.recipient)
+    services = lib.to_services(payload.services, provider_units.ShippingService)
+    options = lib.to_shipping_options(
+        payload.options,
+        option_type=provider_units.ShippingOption,
+    )
+    packages = lib.to_packages(
+        payload.parcels,
+        options=options,
+        package_option_type=provider_units.ShippingOption,
+        shipping_options_initializer=provider_units.shipping_options_initializer,
+    )
+    service = (
+        getattr(services.first, "value", None)
+        or settings.connection_config.account_service_type.state
+        or settings.service_type
+        or "R"
+    )
+
+    request = allied.RateRequestType(
+        bookedBy=shipper.contact,
+        account=settings.account,
+        instructions=options.instructions.state or "N/A",
+        itemCount=len(packages),
+        items=[
+            allied.ItemType(
+                dangerous=(True if pkg.options.dangerous_good.state else False),
+                height=pkg.height.map(provider_units.MeasurementOptions).CM,
+                length=pkg.length.map(provider_units.MeasurementOptions).CM,
+                width=pkg.width.map(provider_units.MeasurementOptions).CM,
+                weight=pkg.weight.map(provider_units.MeasurementOptions).KG,
+                volume=pkg.volume.map(provider_units.MeasurementOptions).m3,
+                itemCount=(pkg.items.quantity if any(pkg.items) else 1),
+            )
+            for pkg in packages
+        ],
+        jobStopsP=allied.JobStopsType(
+            companyName=(shipper.company_name or shipper.contact),
+            contact=shipper.contact,
+            emailAddress=shipper.email or " ",
+            geographicAddress=allied.GeographicAddressType(
+                address1=shipper.address_line1,
+                address2=shipper.address_line2 or " ",
+                country=shipper.country_code,
+                postCode=shipper.postal_code,
+                state=shipper.state_code,
+                suburb=shipper.city,
+            ),
+            phoneNumber=shipper.phone_number or "(00) 0000 0000",
+        ),
+        jobStopsD=allied.JobStopsType(
+            companyName=(recipient.company_name or recipient.contact),
+            contact=recipient.contact,
+            emailAddress=recipient.email or " ",
+            geographicAddress=allied.GeographicAddressType(
+                address1=recipient.address_line1,
+                address2=recipient.address_line2 or " ",
+                country=recipient.country_code,
+                postCode=recipient.postal_code,
+                state=recipient.state_code,
+                suburb=recipient.city,
+            ),
+            phoneNumber=recipient.phone_number or "(00) 0000 0000",
+        ),
+        referenceNumbers=([payload.reference] if any(payload.reference or "") else []),
+        serviceLevel=service,
+        weight=packages.weight.map(provider_units.MeasurementOptions).KG,
+        volume=packages.volume.map(provider_units.MeasurementOptions).m3,
+    )
+
+    return lib.Serializable(
+        request,
+        lambda _: lib.to_json(_)
+        .replace("jobStopsP", "jobStops_P")
+        .replace("jobStopsD", "jobStops_D"),
+        dict(service=service),
+    )

karrio/providers/allied_express/shipment/__init__.py

@@ -0,0 +1,9 @@
+
+from karrio.providers.allied_express.shipment.create import (
+    parse_shipment_response,
+    shipment_request,
+)
+from karrio.providers.allied_express.shipment.cancel import (
+    parse_shipment_cancel_response,
+    shipment_cancel_request,
+)

karrio/providers/allied_express/shipment/cancel.py

@@ -0,0 +1,42 @@
+import karrio.schemas.allied_express.void_request as allied
+import karrio.schemas.allied_express.void_response as shipping
+import typing
+import karrio.lib as lib
+import karrio.core.models as models
+import karrio.providers.allied_express.error as error
+import karrio.providers.allied_express.utils as provider_utils
+import karrio.providers.allied_express.units as provider_units
+
+
+def parse_shipment_cancel_response(
+    _response: lib.Deserializable[provider_utils.AlliedResponse],
+    settings: provider_utils.Settings,
+) -> typing.Tuple[models.ConfirmationDetails, typing.List[models.Message]]:
+    response = _response.deserialize()
+    messages = error.parse_error_response(response, settings)
+    success = not response.is_error and (response.data.get("result")) == "0"
+
+    confirmation = (
+        models.ConfirmationDetails(
+            carrier_id=settings.carrier_id,
+            carrier_name=settings.carrier_name,
+            operation="Cancel Shipment",
+            success=success,
+        )
+        if success
+        else None
+    )
+
+    return confirmation, messages
+
+
+def shipment_cancel_request(
+    payload: models.ShipmentCancelRequest,
+    settings: provider_utils.Settings,
+) -> lib.Serializable:
+    request = allied.VoidRequestType(
+        shipmentno=payload.shipment_identifier,
+        postalcode=(payload.options or {}).get("postal_code", ""),
+    )
+
+    return lib.Serializable(request, lib.to_dict)

karrio/providers/allied_express/shipment/create.py

@@ -0,0 +1,126 @@
+import karrio.schemas.allied_express.label_request as allied
+import karrio.schemas.allied_express.label_response as shipping
+import typing
+import karrio.lib as lib
+import karrio.core.units as units
+import karrio.core.models as models
+import karrio.providers.allied_express.error as error
+import karrio.providers.allied_express.utils as provider_utils
+import karrio.providers.allied_express.units as provider_units
+
+
+def parse_shipment_response(
+    _response: lib.Deserializable[provider_utils.AlliedResponse],
+    settings: provider_utils.Settings,
+) -> typing.Tuple[typing.List[models.RateDetails], typing.List[models.Message]]:
+    response = _response.deserialize()
+
+    messages = error.parse_error_response(response, settings)
+    shipment = (
+        _extract_details(response, settings, ctx=_response.ctx)
+        if not response.is_error and "result" in (response.data or {})
+        else None
+    )
+
+    return shipment, messages
+
+
+def _extract_details(
+    data: provider_utils.AlliedResponse,
+    settings: provider_utils.Settings,
+    ctx: dict = {},
+) -> models.ShipmentDetails:
+    shipment: shipping.LabelResponseType = lib.to_object(
+        shipping.LabelResponseType, data.response
+    )
+    label = shipment.soapenvBody.ns1getLabelResponse.result
+
+    return models.ShipmentDetails(
+        carrier_id=settings.carrier_id,
+        carrier_name=settings.carrier_name,
+        tracking_number=shipment.Tracking,
+        shipment_identifier=shipment.Tracking,
+        label_type="PDF",
+        docs=models.Documents(label=label),
+        meta=dict(
+            postal_code=ctx.get("postal_code", ""),
+        ),
+    )
+
+
+def shipment_request(
+    payload: models.ShipmentRequest,
+    settings: provider_utils.Settings,
+) -> lib.Serializable:
+    shipper = lib.to_address(payload.shipper)
+    recipient = lib.to_address(payload.recipient)
+    service = provider_units.ShippingService.map(payload.service).value_or_key
+    options = lib.to_shipping_options(
+        payload.options,
+        option_type=provider_units.ShippingOption,
+    )
+    packages = lib.to_packages(
+        payload.parcels,
+        options=options,
+        package_option_type=provider_units.ShippingOption,
+        shipping_options_initializer=provider_units.shipping_options_initializer,
+    )
+
+    request = allied.LabelRequestType(
+        bookedBy=shipper.contact,
+        account=settings.account,
+        instructions=options.instructions.state or "N/A",
+        itemCount=len(packages),
+        items=[
+            allied.ItemType(
+                dangerous=(True if pkg.options.dangerous_good.state else False),
+                height=pkg.height.map(provider_units.MeasurementOptions).CM,
+                length=pkg.length.map(provider_units.MeasurementOptions).CM,
+                width=pkg.width.map(provider_units.MeasurementOptions).CM,
+                weight=pkg.weight.map(provider_units.MeasurementOptions).KG,
+                volume=pkg.volume.map(provider_units.MeasurementOptions).m3,
+                itemCount=(pkg.items.quantity if any(pkg.items) else 1),
+            )
+            for pkg in packages
+        ],
+        jobStopsP=allied.JobStopsType(
+            companyName=(shipper.company_name or shipper.contact),
+            contact=shipper.contact,
+            emailAddress=shipper.email or " ",
+            geographicAddress=allied.GeographicAddressType(
+                address1=shipper.address_line1,
+                address2=shipper.address_line2 or " ",
+                country=shipper.country_code,
+                postCode=shipper.postal_code,
+                state=shipper.state_code,
+                suburb=shipper.city,
+            ),
+            phoneNumber=shipper.phone_number or "(00) 0000 0000",
+        ),
+        jobStopsD=allied.JobStopsType(
+            companyName=(recipient.company_name or recipient.contact),
+            contact=recipient.contact,
+            emailAddress=recipient.email or " ",
+            geographicAddress=allied.GeographicAddressType(
+                address1=recipient.address_line1,
+                address2=recipient.address_line2 or " ",
+                country=recipient.country_code,
+                postCode=recipient.postal_code,
+                state=recipient.state_code,
+                suburb=recipient.city,
+            ),
+            phoneNumber=recipient.phone_number or "(00) 0000 0000",
+        ),
+        referenceNumbers=([payload.reference] if any(payload.reference or "") else []),
+        weight=packages.weight.map(provider_units.MeasurementOptions).KG,
+        volume=packages.volume.map(provider_units.MeasurementOptions).m3,
+        serviceLevel=service,
+    )
+
+    return lib.Serializable(
+        request,
+        lambda _: lib.to_json(_)
+        .replace("jobStopsP", "jobStops_P")
+        .replace("jobStopsD", "jobStops_D"),
+        dict(postal_code=recipient.postal_code),
+    )

karrio/providers/allied_express/tracking.py

@@ -0,0 +1,86 @@
+import karrio.schemas.allied_express.tracking_request as allied
+import karrio.schemas.allied_express.tracking_response as tracking
+import typing
+import karrio.lib as lib
+import karrio.core.units as units
+import karrio.core.models as models
+import karrio.providers.allied_express.error as error
+import karrio.providers.allied_express.utils as provider_utils
+import karrio.providers.allied_express.units as provider_units
+
+
+def parse_tracking_response(
+    _response: lib.Deserializable[
+        typing.List[typing.Tuple[str, provider_utils.AlliedResponse]]
+    ],
+    settings: provider_utils.Settings,
+) -> typing.Tuple[typing.List[models.TrackingDetails], typing.List[models.Message]]:
+    responses = _response.deserialize()
+
+    messages: typing.List[models.Message] = sum(
+        [
+            error.parse_error_response(response, settings, tracking_number=_)
+            for _, response in responses
+            if response.is_error
+        ],
+        start=[],
+    )
+    tracking_details = [
+        _extract_details(details.data["result"], settings)
+        for _, details in responses
+        if not details.is_error and "result" in (details.data or {})
+    ]
+
+    return tracking_details, messages
+
+
+def _extract_details(
+    data: dict,
+    settings: provider_utils.Settings,
+) -> models.TrackingDetails:
+    result = lib.to_object(tracking.ResultType, data)
+    description = result.statusBarcodesList.scannedStatus or "In Transit"
+    delivered = "delivered" in description
+    status = next(
+        (
+            status.name
+            for status in list(provider_units.TrackingStatus)
+            if description in status.value
+        ),
+        provider_units.TrackingStatus.in_transit.name,
+    )
+
+    return models.TrackingDetails(
+        carrier_id=settings.carrier_id,
+        carrier_name=settings.carrier_name,
+        tracking_number=result.statusBarcodesList.consignmentNote,
+        events=[
+            models.TrackingEvent(
+                code=result.statusBarcodesList.scannedBarcode,
+                location=result.statusBarcodesList.depotLocation,
+                description=description,
+                date=lib.fdate(
+                    result.statusBarcodesList.scannnedTimestamp,
+                    "%Y-%m-%dT%H:%M:%S.%f%z",
+                ),
+                time=lib.flocaltime(
+                    result.statusBarcodesList.scannnedTimestamp,
+                    "%Y-%m-%dT%H:%M:%S.%f%z",
+                ),
+            )
+        ],
+        status=status,
+        delivered=delivered,
+    )
+
+
+def tracking_request(
+    payload: models.TrackingRequest,
+    settings: provider_utils.Settings,
+) -> lib.Serializable:
+    request = [
+        allied.TrackingRequestType(shipmentno=tracking_number)
+        for tracking_number in payload.tracking_numbers
+    ]
+
+    return lib.Serializable(request, lib.to_dict)

karrio/providers/allied_express/units.py

@@ -0,0 +1,65 @@
+import karrio.lib as lib
+import karrio.core.units as units
+
+MeasurementOptions = lib.units.MeasurementOptionsType(
+    quant=0.1,
+    min_volume=0.1,
+)
+
+
+class PackagingType(lib.StrEnum):
+    """Carrier specific packaging type"""
+
+    PACKAGE = "PACKAGE"
+
+    """ Unified Packaging type mapping """
+    envelope = PACKAGE
+    pak = PACKAGE
+    tube = PACKAGE
+    pallet = PACKAGE
+    small_box = PACKAGE
+    medium_box = PACKAGE
+    your_packaging = PACKAGE
+
+
+class ShippingService(lib.StrEnum):
+    """Carrier specific services"""
+
+    allied_road_service = "R"
+    allied_parcel_service = "P"
+    allied_standard_pallet_service = "PT"
+    allied_oversized_pallet_service = "PT2"
+
+
+class ShippingOption(lib.Enum):
+    """Carrier specific options"""
+
+    instructions = lib.OptionEnum("instructions")
+    dangerous_good = lib.OptionEnum("dangerous_good", bool)
+
+
+def shipping_options_initializer(
+    options: dict,
+    package_options: units.ShippingOptions = None,
+) -> units.ShippingOptions:
+    """
+    Apply default values to the given options.
+    """
+
+    if package_options is not None:
+        options.update(package_options.content)
+
+    def items_filter(key: str) -> bool:
+        return key in ShippingOption  # type: ignore
+
+    return units.ShippingOptions(options, ShippingOption, items_filter=items_filter)
+
+
+class TrackingStatus(lib.Enum):
+    on_hold = ["Other", "DAMAGED"]
+    delivered = ["Freight has been delivered"]
+    in_transit = ["IN TRANSIT TO"]
+    delivery_failed = ["RETURN TO SENDER"]
+    delivery_delayed = ["RETURN TO DEPOT", "CARD LEFT", "LEFT IN DEPOT"]
+    out_for_delivery = ["It's on board with driver"]
+    ready_for_pickup = ["IN AGENT"]

karrio/providers/allied_express/utils.py

@@ -0,0 +1,141 @@
+import attr
+import base64
+import typing
+import karrio.lib as lib
+import karrio.core as core
+
+AlliedServiceType = lib.units.create_enum(
+    "AlliedServiceType",
+    ["R", "P", "PT", "PT2"],
+)
+
+
+class Settings(core.Settings):
+    """Allied Express connection settings."""
+
+    username: str
+    password: str
+    account: str = None
+    service_type: AlliedServiceType = AlliedServiceType.R  # type: ignore
+    account_country_code: str = "AU"
+
+    @property
+    def carrier_name(self):
+        return "allied_express"
+
+    @property
+    def server_url(self):
+        return self.connection_config.server_url.state or (
+            "https://test.aet.mskaleem.com" if self.test_mode else "https://3plapi.com"
+        )
+
+    @property
+    def authorization(self):
+        pair = "%s:%s" % (self.username, self.password)
+        return base64.b64encode(pair.encode("utf-8")).decode("ascii")
+
+    @property
+    def connection_config(self) -> lib.units.Options:
+        return lib.to_connection_config(
+            self.config or {},
+            option_type=ConnectionConfig,
+        )
+
+
+class ConnectionConfig(lib.Enum):
+    account_service_type = lib.OptionEnum("account_service_type", AlliedServiceType)
+    server_url = lib.OptionEnum("server_url")
+    text_color = lib.OptionEnum("text_color")
+    brand_color = lib.OptionEnum("brand_color")
+
+
+@attr.s(auto_attribs=True)
+class AlliedResponse:
+    error: typing.Union[str, None] = None
+    body: typing.Union[dict, None] = None
+    data: typing.Union[dict, None] = None
+    envelope: typing.Union[dict, None] = None
+    response: typing.Union[dict, None] = None
+    is_error: typing.Union[bool, None] = None
+
+
+def parse_response(response: str) -> AlliedResponse:
+    _response = lib.failsafe(
+        lambda: lib.to_dict(
+            (
+                response.replace("soapenv:", "soapenv")
+                .replace("@xmlns:", "xmlns")
+                .replace("ns1:", "ns1")
+            )
+        )
+    )
+
+    if _response is None:
+        _error = response[: response.find(": {")].strip()
+        return AlliedResponse(
+            error=_error if any(_error) else response,
+            is_error=True,
+        )
+
+    _envelope = _response.get("soapenvEnvelope") or {}
+    _body = _envelope.get("soapenvBody") or _response.get("soapenvBody") or {}
+
+    if "ns1getShipmentsStatusResponse" in _body:
+        _data = _body["ns1getShipmentsStatusResponse"]
+        return AlliedResponse(
+            data=_data,
+            body=_body,
+            envelope=_envelope,
+            response=_response,
+            is_error=(
+                ("statusError" in (_data or {}).get("result", {}))
+                or ("errors" in (_data or {}).get("result", {}))
+            ),
+        )
+
+    if "ns1calculatePriceResponse" in _body:
+        _data = _body["ns1calculatePriceResponse"]
+        return AlliedResponse(
+            data=_data,
+            body=_body,
+            envelope=_envelope,
+            response=_response,
+            is_error=(
+                ("statusError" in (_data or {}).get("result", {}))
+                or ("errors" in (_data or {}).get("result", {}))
+            ),
+        )
+
+    if "ns1cancelDispatchJobResponse" in _body:
+        _data = _body["ns1cancelDispatchJobResponse"]
+        return AlliedResponse(
+            data=_data,
+            body=_body,
+            envelope=_envelope,
+            response=_response,
+            is_error=(
+                ((_data or {}).get("result") != "0")
+                or ("statusError" in (_data or {}).get("result", {}))
+                or ("errors" in (_data or {}).get("result", {}))
+            ),
+        )
+
+    if "ns1getLabelResponse" in _body:
+        _data = _body["ns1getLabelResponse"]
+        return AlliedResponse(
+            data=_data,
+            body=_body,
+            envelope=_envelope,
+            response=_response,
+            is_error=(
+                ("statusError" in (_data or {}).get("result", {}))
+                or ("errors" in (_data or {}).get("result", {}))
+            ),
+        )
+
+    return AlliedResponse(
+        body=_body,
+        data=_response,
+        envelope=_envelope,
+        response=_response,
+    )

karrio/schemas/allied_express/label_request.py

@@ -0,0 +1,48 @@
+import attr
+import jstruct
+import typing
+
+
+@attr.s(auto_attribs=True)
+class ItemType:
+    dangerous: typing.Optional[bool] = None
+    height: typing.Optional[int] = None
+    itemCount: typing.Optional[int] = None
+    length: typing.Optional[int] = None
+    volume: typing.Optional[float] = None
+    weight: typing.Optional[int] = None
+    width: typing.Optional[int] = None
+
+
+@attr.s(auto_attribs=True)
+class GeographicAddressType:
+    address1: typing.Optional[str] = None
+    address2: typing.Optional[str] = None
+    country: typing.Optional[str] = None
+    postCode: typing.Optional[int] = None
+    state: typing.Optional[str] = None
+    suburb: typing.Optional[str] = None
+
+
+@attr.s(auto_attribs=True)
+class JobStopsType:
+    companyName: typing.Optional[str] = None
+    contact: typing.Optional[str] = None
+    emailAddress: typing.Optional[str] = None
+    geographicAddress: typing.Optional[GeographicAddressType] = jstruct.JStruct[GeographicAddressType]
+    phoneNumber: typing.Optional[str] = None
+
+
+@attr.s(auto_attribs=True)
+class LabelRequestType:
+    bookedBy: typing.Optional[str] = None
+    account: typing.Optional[str] = None
+    instructions: typing.Optional[str] = None
+    itemCount: typing.Optional[int] = None
+    items: typing.Optional[typing.List[ItemType]] = jstruct.JList[ItemType]
+    jobStopsP: typing.Optional[JobStopsType] = jstruct.JStruct[JobStopsType]
+    jobStopsD: typing.Optional[JobStopsType] = jstruct.JStruct[JobStopsType]
+    referenceNumbers: typing.Optional[typing.List[str]] = None
+    serviceLevel: typing.Optional[str] = None
+    volume: typing.Optional[float] = None
+    weight: typing.Optional[int] = None

karrio/schemas/allied_express/label_response.py

@@ -0,0 +1,60 @@
+import attr
+import jstruct
+import typing
+
+
+@attr.s(auto_attribs=True)
+class SurchargeType:
+    chargeCode: typing.Optional[str] = None
+    description: typing.Optional[str] = None
+    netValue: typing.Optional[str] = None
+    quantity: typing.Optional[int] = None
+
+
+@attr.s(auto_attribs=True)
+class ResultType:
+    jobCharge: typing.Optional[str] = None
+    surcharges: typing.Optional[typing.List[SurchargeType]] = jstruct.JList[SurchargeType]
+    totalCharge: typing.Optional[str] = None
+
+
+@attr.s(auto_attribs=True)
+class Ns1CalculatePriceResponseType:
+    xmlnsns1: typing.Optional[str] = None
+    result: typing.Optional[ResultType] = jstruct.JStruct[ResultType]
+
+
+@attr.s(auto_attribs=True)
+class SoapenvEnvelopeSoapenvBodyType:
+    ns1calculatePriceResponse: typing.Optional[Ns1CalculatePriceResponseType] = jstruct.JStruct[Ns1CalculatePriceResponseType]
+
+
+@attr.s(auto_attribs=True)
+class SoapenvEnvelopeType:
+    xmlnssoapenv: typing.Optional[str] = None
+    xmlnsxsd: typing.Optional[str] = None
+    xmlnsxsi: typing.Optional[str] = None
+    soapenvBody: typing.Optional[SoapenvEnvelopeSoapenvBodyType] = jstruct.JStruct[SoapenvEnvelopeSoapenvBodyType]
+
+
+@attr.s(auto_attribs=True)
+class PriceType:
+    soapenvEnvelope: typing.Optional[SoapenvEnvelopeType] = jstruct.JStruct[SoapenvEnvelopeType]
+
+
+@attr.s(auto_attribs=True)
+class Ns1GetLabelResponseType:
+    xmlnsns1: typing.Optional[str] = None
+    result: typing.Optional[str] = None
+
+
+@attr.s(auto_attribs=True)
+class LabelResponseSoapenvBodyType:
+    ns1getLabelResponse: typing.Optional[Ns1GetLabelResponseType] = jstruct.JStruct[Ns1GetLabelResponseType]
+
+
+@attr.s(auto_attribs=True)
+class LabelResponseType:
+    Price: typing.Optional[PriceType] = jstruct.JStruct[PriceType]
+    Tracking: typing.Optional[str] = None
+    soapenvBody: typing.Optional[LabelResponseSoapenvBodyType] = jstruct.JStruct[LabelResponseSoapenvBodyType]

karrio/schemas/allied_express/rate_request.py

@@ -0,0 +1,48 @@
+import attr
+import jstruct
+import typing
+
+
+@attr.s(auto_attribs=True)
+class ItemType:
+    dangerous: typing.Optional[bool] = None
+    height: typing.Optional[int] = None
+    itemCount: typing.Optional[int] = None
+    length: typing.Optional[int] = None
+    volume: typing.Optional[float] = None
+    weight: typing.Optional[int] = None
+    width: typing.Optional[int] = None
+
+
+@attr.s(auto_attribs=True)
+class GeographicAddressType:
+    address1: typing.Optional[str] = None
+    address2: typing.Optional[str] = None
+    country: typing.Optional[str] = None
+    postCode: typing.Optional[int] = None
+    state: typing.Optional[str] = None
+    suburb: typing.Optional[str] = None
+
+
+@attr.s(auto_attribs=True)
+class JobStopsType:
+    companyName: typing.Optional[str] = None
+    contact: typing.Optional[str] = None
+    emailAddress: typing.Optional[str] = None
+    geographicAddress: typing.Optional[GeographicAddressType] = jstruct.JStruct[GeographicAddressType]
+    phoneNumber: typing.Optional[str] = None
+
+
+@attr.s(auto_attribs=True)
+class RateRequestType:
+    bookedBy: typing.Optional[str] = None
+    account: typing.Optional[str] = None
+    instructions: typing.Optional[str] = None
+    itemCount: typing.Optional[int] = None
+    items: typing.Optional[typing.List[ItemType]] = jstruct.JList[ItemType]
+    jobStopsP: typing.Optional[JobStopsType] = jstruct.JStruct[JobStopsType]
+    jobStopsD: typing.Optional[JobStopsType] = jstruct.JStruct[JobStopsType]
+    referenceNumbers: typing.Optional[typing.List[str]] = None
+    serviceLevel: typing.Optional[str] = None
+    volume: typing.Optional[float] = None
+    weight: typing.Optional[int] = None

karrio/schemas/allied_express/rate_response.py

@@ -0,0 +1,42 @@
+import attr
+import jstruct
+import typing
+
+
+@attr.s(auto_attribs=True)
+class SurchargeType:
+    chargeCode: typing.Optional[str] = None
+    description: typing.Optional[str] = None
+    netValue: typing.Optional[str] = None
+    quantity: typing.Optional[int] = None
+
+
+@attr.s(auto_attribs=True)
+class ResultType:
+    jobCharge: typing.Optional[str] = None
+    surcharges: typing.Optional[typing.List[SurchargeType]] = jstruct.JList[SurchargeType]
+    totalCharge: typing.Optional[str] = None
+
+
+@attr.s(auto_attribs=True)
+class Ns1CalculatePriceResponseType:
+    xmlnsns1: typing.Optional[str] = None
+    result: typing.Optional[ResultType] = jstruct.JStruct[ResultType]
+
+
+@attr.s(auto_attribs=True)
+class SoapenvBodyType:
+    ns1calculatePriceResponse: typing.Optional[Ns1CalculatePriceResponseType] = jstruct.JStruct[Ns1CalculatePriceResponseType]
+
+
+@attr.s(auto_attribs=True)
+class SoapenvEnvelopeType:
+    xmlnssoapenv: typing.Optional[str] = None
+    xmlnsxsd: typing.Optional[str] = None
+    xmlnsxsi: typing.Optional[str] = None
+    soapenvBody: typing.Optional[SoapenvBodyType] = jstruct.JStruct[SoapenvBodyType]
+
+
+@attr.s(auto_attribs=True)
+class RateResponseType:
+    soapenvEnvelope: typing.Optional[SoapenvEnvelopeType] = jstruct.JStruct[SoapenvEnvelopeType]

karrio/schemas/allied_express/tracking_request.py

@@ -0,0 +1,8 @@
+import attr
+import jstruct
+import typing
+
+
+@attr.s(auto_attribs=True)
+class TrackingRequestType:
+    shipmentno: typing.Optional[int] = None

karrio/schemas/allied_express/tracking_response.py

@@ -0,0 +1,33 @@
+import attr
+import jstruct
+import typing
+
+
+@attr.s(auto_attribs=True)
+class StatusBarcodesListType:
+    consignmentNote: typing.Optional[str] = None
+    depotLocation: typing.Optional[str] = None
+    scannedBarcode: typing.Optional[str] = None
+    scannedStatus: typing.Optional[str] = None
+    scannnedTimestamp: typing.Optional[str] = None
+
+
+@attr.s(auto_attribs=True)
+class ResultType:
+    statusBarcodesList: typing.Optional[StatusBarcodesListType] = jstruct.JStruct[StatusBarcodesListType]
+
+
+@attr.s(auto_attribs=True)
+class Ns1GetShipmentsStatusResponseType:
+    xmlnsns1: typing.Optional[str] = None
+    result: typing.Optional[ResultType] = jstruct.JStruct[ResultType]
+
+
+@attr.s(auto_attribs=True)
+class SoapenvBodyType:
+    ns1getShipmentsStatusResponse: typing.Optional[Ns1GetShipmentsStatusResponseType] = jstruct.JStruct[Ns1GetShipmentsStatusResponseType]
+
+
+@attr.s(auto_attribs=True)
+class TrackingResponseType:
+    soapenvBody: typing.Optional[SoapenvBodyType] = jstruct.JStruct[SoapenvBodyType]

karrio/schemas/allied_express/void_request.py

@@ -0,0 +1,9 @@
+import attr
+import jstruct
+import typing
+
+
+@attr.s(auto_attribs=True)
+class VoidRequestType:
+    shipmentno: typing.Optional[int] = None
+    postalcode: typing.Optional[int] = None

karrio/schemas/allied_express/void_response.py

@@ -0,0 +1,27 @@
+import attr
+import jstruct
+import typing
+
+
+@attr.s(auto_attribs=True)
+class Ns1CancelDispatchJobResponseType:
+    xmlnsns1: typing.Optional[str] = None
+    result: typing.Optional[int] = None
+
+
+@attr.s(auto_attribs=True)
+class SoapenvBodyType:
+    ns1cancelDispatchJobResponse: typing.Optional[Ns1CancelDispatchJobResponseType] = jstruct.JStruct[Ns1CancelDispatchJobResponseType]
+
+
+@attr.s(auto_attribs=True)
+class SoapenvEnvelopeType:
+    xmlnssoapenv: typing.Optional[str] = None
+    xmlnsxsd: typing.Optional[str] = None
+    xmlnsxsi: typing.Optional[str] = None
+    soapenvBody: typing.Optional[SoapenvBodyType] = jstruct.JStruct[SoapenvBodyType]
+
+
+@attr.s(auto_attribs=True)
+class VoidResponseType:
+    soapenvEnvelope: typing.Optional[SoapenvEnvelopeType] = jstruct.JStruct[SoapenvEnvelopeType]

karrio_allied_express-2025.5rc1.dist-info/METADATA

@@ -0,0 +1,45 @@
+Metadata-Version: 2.4
+Name: karrio_allied_express
+Version: 2025.5rc1
+Summary: Karrio - Allied Express Shipping Extension
+Author-email: karrio <hello@karrio.io>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/karrioapi/karrio
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+Requires-Dist: karrio
+
+
+# karrio.allied_express
+
+This package is a Allied Express extension of the [karrio](https://pypi.org/project/karrio) multi carrier shipping SDK.
+
+## Requirements
+
+`Python 3.7+`
+
+## Installation
+
+```bash
+pip install karrio.allied_express
+```
+
+## Usage
+
+```python
+import karrio.sdk as karrio
+from karrio.mappers.allied_express.settings import Settings
+
+
+# Initialize a carrier gateway
+allied_express = karrio.gateway["allied_express"].create(
+    Settings(
+        ...
+    )
+)
+```
+
+Check the [Karrio Mutli-carrier SDK docs](https://docs.karrio.io) for Shipping API requests

karrio_allied_express-2025.5rc1.dist-info/RECORD

@@ -0,0 +1,28 @@
+karrio/mappers/allied_express/__init__.py,sha256=8NXjNyWIlawq4SM8hVhxcgq-p6wfUrJ6XiSV5mHfl8Q,170
+karrio/mappers/allied_express/mapper.py,sha256=BVBe2MNzJeHfCFrVxoOClkCbFJbt1s997RzySQ4x4c8,2040
+karrio/mappers/allied_express/proxy.py,sha256=f5-LkSzCrL2GXixlZHyf2Dky0lYBieUXFvyllhFWq-w,2789
+karrio/mappers/allied_express/settings.py,sha256=N6-y9jnKUaVy3xPwXhDYc0bsz4Jrqcflr13VJ-yV2Cc,582
+karrio/plugins/allied_express/__init__.py,sha256=kZKqmVG4Mgqgd1H4DPNftyA1_6Mr3bPQGfQP8beGpWI,562
+karrio/providers/allied_express/__init__.py,sha256=ZaBspoVXxTttEzcQgBwlzW8AiXkwISJcb9AMA1kLnpc,424
+karrio/providers/allied_express/error.py,sha256=8AmPzB1LSRVq4OGoLgD9EkGJRZ5YxuGTvhcVn_waL8E,896
+karrio/providers/allied_express/rate.py,sha256=WIyuI6ITD4aRKdPnZcekuGwUNFxYZEsbKunnD2N7e8g,5430
+karrio/providers/allied_express/tracking.py,sha256=CZ0hy24MBg2CUFwkjE7OEt198E5MjxIIBhnnKqWe_Bc,2852
+karrio/providers/allied_express/units.py,sha256=7q0pXy6dlqOujnYeWskpNpULxypESKafcCuqDDKW-7U,1679
+karrio/providers/allied_express/utils.py,sha256=qWPrFRagbw_YT_iBGhiz8mL5VibKcUXLo8hT3npnq-w,4170
+karrio/providers/allied_express/shipment/__init__.py,sha256=I66Y4E1sezhvF0ZmVTh2Tw1xj2xGpBnSdanYceaGdHg,245
+karrio/providers/allied_express/shipment/cancel.py,sha256=UJ1sI4FxW0p11lLxdYX-8O53HwMoPj3z-Y4IRIaB_bI,1429
+karrio/providers/allied_express/shipment/create.py,sha256=wcs8nNe9fXGvHp1Rr5Tqpc0dd5uYNREJQ5MhqIol9dc,4871
+karrio/schemas/allied_express/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+karrio/schemas/allied_express/label_request.py,sha256=ngo3Kg9sRkJPntxKJc7z7gg75Q2jWM_OuZXDjs055J0,1653
+karrio/schemas/allied_express/label_response.py,sha256=Jfith_7em6E3duxJStXG_nke4j0vwgzZMpuNEUGoeNE,1896
+karrio/schemas/allied_express/rate_request.py,sha256=qMTxT9usodSYWdyYlNRvwMxF7DiwFRy0ijATXcxjIEc,1652
+karrio/schemas/allied_express/rate_response.py,sha256=V6jBUje5U2gML5urk8s_WyWkMVMJL0-ypVbfJEbxRaA,1268
+karrio/schemas/allied_express/tracking_request.py,sha256=JKZYhlhzo8f9e8TVcBg9jddR73TJJMo1x4AqKKySKbc,141
+karrio/schemas/allied_express/tracking_response.py,sha256=dFxS-U4LxUW2IjaThfDxsoH5R9RJFe7qFYz6w1EEi1w,1010
+karrio/schemas/allied_express/void_request.py,sha256=UEWq6f-WVtNtiZOwEaeSYMs6XuuDmAKs6tIcjIvPPxA,181
+karrio/schemas/allied_express/void_response.py,sha256=ldHlbqsb-TsfSwBBXiXis6Blpx97fZ1VZn0jqYANR-c,801
+karrio_allied_express-2025.5rc1.dist-info/METADATA,sha256=aFe4-zi-c6mZjFpcnCqVnUqrKjj7aMxv_5MlpByp2Oo,1048
+karrio_allied_express-2025.5rc1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+karrio_allied_express-2025.5rc1.dist-info/entry_points.txt,sha256=kyxJtJulN0JYgZMTnWl1sIpiT2l_g7TNMlPu8w68w7Q,73
+karrio_allied_express-2025.5rc1.dist-info/top_level.txt,sha256=FZCY8Nwft8oEGHdl--xku8P3TrnOxu5dETEU_fWpRSM,20
+karrio_allied_express-2025.5rc1.dist-info/RECORD,,

karrio_allied_express-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_allied_express-2025.5rc1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[karrio.plugins]
+allied_express = karrio.plugins.allied_express:METADATA

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

@@ -0,0 +1,3 @@
+dist
+karrio
+schemas