karrio-hay-post 2025.5rc1__py3-none-any.whl

karrio/mappers/hay_post/__init__.py

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

karrio/mappers/hay_post/mapper.py

@@ -0,0 +1,40 @@
+"""Karrio HayPost client mapper."""
+
+import typing
+import karrio.lib as lib
+import karrio.api.mapper as mapper
+import karrio.core.models as models
+import karrio.providers.hay_post as provider
+import karrio.mappers.hay_post.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 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/hay_post/proxy.py

@@ -0,0 +1,61 @@
+"""Karrio HayPost client proxy."""
+
+import karrio.lib as lib
+import karrio.api.proxy as proxy
+import karrio.mappers.hay_post.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}/Api/Order/CalculateTariff",
+            data=lib.to_json(lib.to_list(request.serialize())),
+            trace=self.trace_as("json"),
+            method="POST",
+            headers={
+                "Accept": "application/json",
+                "Content-Type": "application/json",
+                "Authorization": self.settings.authorization,
+            },
+            proxy=self.settings.proxy,
+        )
+
+        response_dict = {"rates": response, "request": request.value}
+
+        return lib.Deserializable(response_dict, lib.to_dict)
+
+    def create_shipment(self, request: lib.Serializable) -> lib.Deserializable[str]:
+        response = lib.request(
+            url=f"{self.settings.server_url}/Api/Order/CreateOrderByCustomerShort",
+            data=lib.to_json(request.serialize()),
+            trace=self.trace_as("json"),
+            method="POST",
+            headers={
+                "Accept": "application/json",
+                "Content-Type": "application/json",
+                "Authorization": self.settings.authorization,
+            },
+            proxy=self.settings.proxy,
+        )
+
+        return lib.Deserializable(response, lib.to_dict)
+
+    def get_tracking(self, request: lib.Serializable) -> lib.Deserializable[str]:
+        query = request.serialize()
+        trackingnumber = query[0]
+
+        response = lib.request(
+            url=f"{self.settings.server_url}/Api/Order/Tracking/{trackingnumber}",
+            trace=self.trace_as("json"),
+            method="GET",
+            proxy=self.settings.proxy,
+            headers={
+                "Accept": "application/json",
+                "Content-Type": "application/json",
+                "Authorization": self.settings.authorization,
+            },
+        )
+
+        return lib.Deserializable(response, lib.to_dict)

karrio/mappers/hay_post/settings.py

@@ -0,0 +1,23 @@
+"""Karrio HayPost client settings."""
+
+import attr
+import karrio.providers.hay_post.utils as provider_utils
+
+
+@attr.s(auto_attribs=True)
+class Settings(provider_utils.Settings):
+    """HayPost connection settings."""
+
+    # required carrier specific properties
+    username: str
+    password: str
+    customer_id: str
+    customer_type: str
+
+    # generic properties
+    id: str = None
+    test_mode: bool = False
+    carrier_id: str = "hay_post"
+    account_country_code: str = None
+    metadata: dict = {}
+    config: dict = {}

karrio/plugins/hay_post/__init__.py

@@ -0,0 +1,23 @@
+import karrio.core.metadata as metadata
+import karrio.mappers.hay_post as mappers
+import karrio.providers.hay_post.units as units
+
+
+METADATA = metadata.PluginMetadata(
+    status="beta",
+    id="hay_post",
+    label="HayPost",
+
+    # Integrations
+    Mapper=mappers.Mapper,
+    Proxy=mappers.Proxy,
+    Settings=mappers.Settings,
+
+    # Data Units
+    services=units.ShippingService,
+    options=units.ShippingOption,
+    connection_configs=units.ConnectionConfig,
+    # package_presets=units.PackagePresets,  # Enum of parcel presets/templates
+
+    is_hub=False
+)

karrio/providers/hay_post/__init__.py

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

karrio/providers/hay_post/error.py

@@ -0,0 +1,30 @@
+import typing
+import karrio.lib as lib
+import karrio.core.models as models
+import karrio.providers.hay_post.utils as provider_utils
+
+import karrio.schemas.hay_post.error as hay_post
+
+
+def parse_error_response(
+    response: dict,
+    settings: provider_utils.Settings,
+    **kwargs,
+) -> typing.List[models.Message]:
+    responses = response if isinstance(response, list) else [response]
+
+    errors: typing.List[hay_post.ErrorType] = [
+        lib.to_object(hay_post.ErrorType, error) for error in responses
+    ]
+
+    return [
+        models.Message(
+            carrier_id=settings.carrier_id,
+            carrier_name=settings.carrier_name,
+            code="error",
+            message=" ".join(error.key.split("_")).capitalize(),
+            details={**kwargs},
+        )
+        for error in errors
+        if error.key is not None
+    ]

karrio/providers/hay_post/rate.py

@@ -0,0 +1,115 @@
+import typing
+import karrio.lib as lib
+import karrio.core.models as models
+import karrio.providers.hay_post.error as error
+
+import karrio.providers.hay_post.utils as provider_utils
+import karrio.providers.hay_post.units as provider_units
+import karrio.schemas.hay_post.tariff_request as hay_post
+
+
+def parse_rate_response(
+    _response: lib.Deserializable[dict],
+    settings: provider_utils.Settings,
+) -> typing.Tuple[typing.List[models.RateDetails], typing.List[models.Message]]:
+    response = _response.deserialize()
+    rate_response = lib.to_dict(response.get("rates"))
+
+    messages = error.parse_error_response(response, settings)
+    rates = [
+        (
+            _extract_details(response, settings)
+            if not isinstance(rate_response, dict)
+            else None
+        )
+    ]
+
+    return rates, messages
+
+
+def _extract_details(
+    data: dict,
+    settings: provider_utils.Settings,
+) -> models.RateDetails:
+    service = provider_units.ShippingService.map(
+        str(data.get("request", {}).get("serviceCategoryDirectionId", 0))
+    )
+    currency = provider_units.ShippingCurrency.map(
+        str(data.get("request", {}).get("currencyId", 0))
+    ).name
+
+    return models.RateDetails(
+        carrier_id=settings.carrier_id,
+        carrier_name=settings.carrier_name,
+        service=service.name_or_key,
+        total_charge=lib.to_money(data.get("rates", 0)),
+        currency=currency,
+    )
+
+
+def rate_request(
+    payload: models.RateRequest,
+    settings: provider_utils.Settings,
+) -> lib.Serializable:
+    shipper = lib.to_address(payload.shipper)
+    recipient = lib.to_address(payload.recipient)
+    packages = lib.to_packages(payload.parcels)
+
+    options = lib.to_shipping_options(
+        payload.options,
+        package_options=packages.options,
+        initializer=provider_units.shipping_options_initializer,
+    )
+
+    service = (
+        lib.to_services(payload.services, provider_units.ShippingService).first
+        or provider_units.ShippingService.yes_ordered_value
+    )
+
+    currency_id = lib.to_int(
+        provider_units.ShippingCurrency.map(options.currency.state).value
+        or provider_units.ShippingCurrency.AMD.value
+    )
+    additional_services = [
+        int(service.value.code)
+        for service in provider_units.ShippingOption
+        if service.name in options
+    ]
+
+    if not additional_services:
+        additional_services.append(
+            int(provider_units.ShippingOption.notification.value.code)
+        )
+
+    request = hay_post.TariffRequestElementType(
+        customerId=int(settings.customer_id),
+        serviceCategoryDirectionId=int(service.value),
+        weight=packages.weight.value,
+        totalPrice=packages.total_value if packages.total_value else 0,
+        currencyId=currency_id,
+        destinationAddress=hay_post.NAddressType(
+            cityVillage=recipient.city,
+            address=recipient.address_line1,
+            postalCode=recipient.postal_code,
+            receiverInfo=hay_post.ReceiverInfoType(
+                companyName=recipient.company_name,
+                firstName=recipient.person_name,
+                phoneNumber=recipient.phone_number,
+                email=recipient.email,
+            ),
+        ),
+        returnAddress=hay_post.NAddressType(
+            cityVillage=shipper.city,
+            address=shipper.address_line1,
+            postalCode=shipper.postal_code,
+            receiverInfo=hay_post.ReceiverInfoType(
+                companyName=shipper.company_name,
+                firstName=shipper.person_name,
+                phoneNumber=shipper.phone_number,
+                email=shipper.email,
+            ),
+        ),
+        additionalServices=additional_services,
+    )
+
+    return lib.Serializable(request, lib.to_dict)

karrio/providers/hay_post/shipment/__init__.py

@@ -0,0 +1,5 @@
+
+from karrio.providers.hay_post.shipment.create import (
+    parse_shipment_response,
+    shipment_request,
+)

karrio/providers/hay_post/shipment/create.py

@@ -0,0 +1,106 @@
+import typing
+import karrio.lib as lib
+import karrio.core.units as units
+import karrio.core.models as models
+import karrio.providers.hay_post.error as error
+import karrio.providers.hay_post.utils as provider_utils
+import karrio.providers.hay_post.units as provider_units
+import karrio.schemas.hay_post.order_create_request as hay_post
+import karrio.schemas.hay_post.order_create_response as hay_post_response
+
+
+def parse_shipment_response(
+    _response: lib.Deserializable[dict],
+    settings: provider_utils.Settings,
+) -> typing.Tuple[models.ShipmentDetails, typing.List[models.Message]]:
+    response = _response.deserialize()
+
+    messages = error.parse_error_response(response, settings)
+    shipment = (
+        _extract_details(response, settings) if response.get("key") is None else None
+    )
+
+    return shipment, messages
+
+
+def _extract_details(
+    data: dict,
+    settings: provider_utils.Settings,
+) -> models.ShipmentDetails:
+    shipment = lib.to_object(hay_post_response.OrderCreateResponseType, data)
+    return models.ShipmentDetails(
+        carrier_id=settings.carrier_id,
+        carrier_name=settings.carrier_name,
+        tracking_number=shipment.barcode,
+        shipment_identifier=str(shipment.id),
+        docs=models.Documents(
+            label="No label...",
+        ),
+        meta=dict(
+            revertOrderId=shipment.revertOrderId,
+            revertBarcode=shipment.revertBarcode,
+            postalcode=shipment.postalcode,
+        ),
+    )
+
+
+def shipment_request(
+    payload: models.ShipmentRequest,
+    settings: provider_utils.Settings,
+) -> lib.Serializable:
+    shipper = lib.to_address(payload.shipper)
+    recipient = lib.to_address(payload.recipient)
+    packages = lib.to_packages(payload.parcels)
+    service = provider_units.ShippingService.map(payload.service)
+
+    options = lib.to_shipping_options(
+        payload.options,
+        package_options=packages.options,
+        initializer=provider_units.shipping_options_initializer,
+    )
+
+    additional_services = [
+        int(service.value.code)
+        for service in provider_units.ShippingOption
+        if service.name in options
+    ]
+
+    shipper_country_id = lib.to_int(
+        provider_units.ShippingCountries.map(shipper.country_code).value
+    )
+    recipient_country_id = lib.to_int(
+        provider_units.ShippingCountries.map(recipient.country_code).value
+    )
+
+    request = hay_post.OrderCreateRequestType(
+        customerId=int(settings.customer_id),
+        serviceCategoryDirectionId=service.value,
+        weight=packages.weight.value,
+        destinationAddress=hay_post.NAddressType(
+            countryId=recipient_country_id,
+            street=recipient.street,
+            cityVillage=recipient.city,
+            postalCode=recipient.postal_code,
+            receiverInfo=hay_post.ReceiverInfoType(
+                companyName=recipient.company_name,
+                firstName=recipient.person_name,
+                phoneNumber=recipient.phone_number,
+                email=recipient.email,
+            ),
+        ),
+        returnAddress=hay_post.NAddressType(
+            countryId=shipper_country_id,
+            street=shipper.street,
+            cityVillage=shipper.city,
+            postalCode=shipper.postal_code,
+            receiverInfo=hay_post.ReceiverInfoType(
+                companyName=shipper.company_name,
+                firstName=shipper.person_name,
+                phoneNumber=shipper.phone_number,
+                email=shipper.email,
+            ),
+        ),
+        additionalServices=additional_services,
+    )
+
+    return lib.Serializable(request, lib.to_dict)

karrio/providers/hay_post/tracking.py

@@ -0,0 +1,82 @@
+import typing
+import karrio.lib as lib
+import karrio.core.models as models
+import karrio.providers.hay_post.error as error
+import karrio.providers.hay_post.units as provider_units
+import karrio.providers.hay_post.utils as provider_utils
+import karrio.schemas.hay_post.order_tracking_response as hay_post
+
+from datetime import datetime
+
+
+def parse_tracking_response(
+    _response: lib.Deserializable[dict],
+    settings: provider_utils.Settings,
+) -> typing.Tuple[typing.List[models.TrackingDetails], typing.List[models.Message]]:
+    response = _response.deserialize()
+
+    messages = error.parse_error_response(response, settings)
+    tracking_details = [
+        _extract_details(response, settings) if response.get("key") is None else None
+    ]
+
+    return tracking_details, messages
+
+
+def _extract_details(
+    data: dict,
+    settings: provider_utils.Settings,
+) -> models.TrackingDetails:
+    detail = lib.to_object(hay_post.OrderTrackingResponseType, data)
+
+    status = next(
+        (
+            status.name
+            for status in list(provider_units.TrackingStatus)
+            if detail.order.stateId in status.value
+        ),
+        provider_units.TrackingStatus.delivered.name,
+    )
+
+    return models.TrackingDetails(
+        tracking_number=detail.order.trackingId,
+        carrier_name=settings.carrier_name,
+        carrier_id=settings.carrier_id,
+        info=models.TrackingInfo(
+            customer_name=f"{detail.customer.firstName} {detail.customer.lastName}",
+            note=detail.order.comment,
+            order_date=lib.fdate(detail.order.createDate, "%Y-%m-%dT%H:%M:%S"),
+            order_id=str(detail.order.id),
+            package_weight=str(detail.order.weight),
+            shipment_pickup_date=lib.fdate(
+                detail.order.createDate, "%Y-%m-%dT%H:%M:%S"
+            ),
+            shipment_service=detail.order.service.name,
+            shipment_origin_country=detail.returnAddress.country.name,
+            shipment_origin_postal_code=detail.returnAddress.postalCode,
+            shipment_destination_country=detail.orderDestinationAddress.country.name,
+            shipment_destination_postal_code=detail.orderDestinationAddress.country.name,
+        ),
+        events=[
+            models.TrackingEvent(
+                date=lib.fdate(detail.order.createDate, "%Y-%m-%dT%H:%M:%S"),
+                description=(
+                    detail.order.comment if detail.order.comment else "No description"
+                ),
+                code=detail.order.transactionId,
+                time=lib.fdate(detail.order.createDate, "%Y-%m-%dT%H:%M:%S"),
+                location=detail.orderDestinationAddress.address,
+            )
+        ],
+        delivered=status == "delivered",
+        status=status,
+    )
+
+
+def tracking_request(
+    payload: models.TrackingRequest,
+    settings: provider_utils.Settings,
+) -> lib.Serializable:
+    request = payload.tracking_numbers
+
+    return lib.Serializable(request)

karrio/providers/hay_post/units.py

@@ -0,0 +1,303 @@
+import karrio.lib as lib
+import karrio.core.units as units
+
+
+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 ShippingCurrency(lib.StrEnum):
+    RUB = "3"
+    USD = "2"
+    EUR = "4"
+    AMD = "1"
+
+
+class ShippingService(lib.StrEnum):
+    """Carrier specific services"""
+
+    letter_ordered = "88"
+    letter_simple = "79"
+    letter_valued = "89"
+    package_ordered = "93"
+    package_simple = "92"
+    package_valued = "100"
+    parcel_simple = "94"
+    parcel_valued = "95"
+    postcard_ordered = "91"
+    postcard_simple = "90"
+    sekogram_simple = "96"
+    sprint_simple = "97"
+    yes_ordered_value = "99"
+
+
+class ShippingOption(lib.Enum):
+    """Carrier specific options"""
+
+    notification = lib.OptionEnum("2", bool)
+    ordered_packaging = lib.OptionEnum("3", bool)
+    pick_up = lib.OptionEnum("4", bool)
+    postmen_delivery_value = lib.OptionEnum("5", bool)
+    delivery = lib.OptionEnum("6", bool)
+    international_notification = lib.OptionEnum("15", bool)
+    domestic_sms = lib.OptionEnum("16", bool)
+    international_sms = lib.OptionEnum("17", bool)
+
+
+def shipping_options_initializer(
+    options: dict,
+    package_options: units.ShippingOptions = None,
+) -> units.ShippingOptions:
+    """
+    Apply default values to the given options.
+    """
+    _options = options.copy()
+
+    if package_options is not None:
+        _options.update(package_options.content)
+
+    return units.ShippingOptions(_options, ShippingOption)
+
+
+class ConnectionConfig(lib.Enum):
+    shipping_options = lib.OptionEnum("shipping_options", list)
+    shipping_services = lib.OptionEnum("shipping_services", list)
+
+
+class TrackingStatus(lib.Enum):
+    on_hold = [11]
+    delivered = [6]
+    in_transit = [1, 2, 7, 5]
+    delivery_failed = [10, 3, 4]
+    delivery_delayed = [8, 9]
+
+
+class ShippingCountries(lib.Enum):
+    """Country codes"""
+
+    AF = 1
+    AL = 2
+    DZ = 3
+    AS = 4
+    AD = 5
+    AO = 6
+    AG = 9
+    AR = 10
+    AM = 11
+    AW = 12
+    AU = 13
+    AT = 14
+    BS = 16
+    BH = 17
+    BD = 18
+    BB = 19
+    BY = 20
+    BE = 21
+    BZ = 22
+    BJ = 23
+    BT = 25
+    BO = 26
+    BA = 28
+    BW = 29
+    BR = 31
+    VG = 33
+    BG = 35
+    BF = 36
+    BI = 37
+    CV = 38
+    KH = 39
+    CM = 40
+    CA = 41
+    KY = 42
+    CF = 43
+    TD = 44
+    CL = 45
+    CN = 46
+    HK = 47
+    MO = 47
+    CO = 51
+    KM = 52
+    CG = 53
+    CK = 54
+    CR = 55
+    HR = 56
+    CU = 57
+    CY = 59
+    CZ = 60
+    CD = 63
+    DK = 64
+    DJ = 65
+    DM = 66
+    DO = 67
+    EC = 68
+    EG = 69
+    SV = 70
+    GQ = 71
+    ER = 72
+    EE = 73
+    ET = 74
+    FJ = 77
+    FI = 78
+    FR = 79
+    GF = 80
+    PF = 81
+    GA = 83
+    GM = 84
+    GE = 85
+    DE = 86
+    GH = 87
+    GR = 89
+    GD = 91
+    GU = 93
+    GT = 94
+    GN = 96
+    GW = 97
+    GY = 98
+    HT = 99
+    HN = 102
+    HU = 103
+    IS = 104
+    IN = 105
+    ID = 106
+    IQ = 108
+    IE = 109
+    IL = 111
+    IT = 112
+    JM = 113
+    JP = 114
+    JO = 116
+    KZ = 117
+    KE = 118
+    KI = 119
+    KW = 120
+    KG = 121
+    LV = 123
+    LB = 124
+    LS = 125
+    LY = 127
+    LI = 128
+    LT = 129
+    LU = 130
+    MG = 131
+    MW = 132
+    MY = 133
+    MV = 134
+    ML = 135
+    MT = 136
+    MH = 137
+    MQ = 138
+    MR = 139
+    MU = 140
+    MX = 142
+    FM = 143
+    MC = 144
+    MN = 145
+    ME = 146
+    MZ = 149
+    MM = 150
+    NA = 151
+    NR = 152
+    NP = 153
+    NL = 154
+    NC = 155
+    NZ = 156
+    NI = 157
+    NE = 158
+    NG = 159
+    NU = 160
+    MP = 162
+    NO = 163
+    OM = 164
+    PK = 165
+    PW = 166
+    PA = 167
+    PG = 168
+    PY = 169
+    PE = 170
+    PH = 171
+    PL = 173
+    PT = 174
+    PR = 175
+    QA = 176
+    MD = 178
+    RO = 179
+    RU = 180
+    RW = 181
+    KN = 185
+    VC = 189
+    WS = 190
+    SM = 191
+    ST = 192
+    SA = 193
+    SN = 194
+    RS = 195
+    SC = 196
+    SL = 197
+    SG = 198
+    SK = 200
+    SI = 201
+    SB = 202
+    SO = 203
+    ZA = 204
+    ES = 207
+    LK = 208
+    PS = 209
+    SD = 210
+    SR = 211
+    SE = 214
+    CH = 215
+    SY = 216
+    TJ = 217
+    TH = 218
+    TL = 220
+    TG = 221
+    TO = 223
+    TT = 224
+    TN = 225
+    TM = 227
+    TV = 229
+    UG = 230
+    UA = 231
+    AE = 232
+    GB = 233
+    TZ = 234
+    US = 237
+    UY = 238
+    UZ = 239
+    VU = 240
+    VE = 241
+    VN = 242
+    YE = 245
+    ZM = 246
+    ZW = 247
+    BN = 252
+    GP = 253
+    SZ = 254
+    BL = 255
+    VA = 256
+    KR = 257
+    KP = 258
+    IR = 454
+    TW = 455
+    TR = 456
+    JE = 458
+    MK = 459
+    CW = 460
+    BM = 464
+    LA = 465
+    LR = 466
+    MA = 467
+    LC = 468
+    SS = 469
+    CI = 470

karrio/providers/hay_post/utils.py

@@ -0,0 +1,65 @@
+import json
+import karrio.lib as lib
+import karrio.core as core
+
+
+class Settings(core.Settings):
+    """HayPost connection settings."""
+
+    username: str
+    password: str
+    customer_id: str
+    customer_type: str
+
+    @property
+    def proxy(self):
+        # Add proxy for using hay_post API in test mode
+        if self.test_mode:
+            return "username:passowrd@host:port"
+        return None
+
+    @property
+    def carrier_name(self):
+        return "hay_post"
+
+    @property
+    def connection_config(self) -> lib.units.Options:
+        from karrio.providers.hay_post.units import ConnectionConfig
+
+        return lib.to_connection_config(
+            self.config or {},
+            option_type=ConnectionConfig,
+        )
+
+    @property
+    def server_url(self):
+        if self.test_mode:
+            return "https://dev-order.haypost.am"
+        return "https://order.haypost.am"
+
+    @property
+    def authorization(self):
+        url = "https://identity.haypost.am/api/Connect/Token"
+        if self.test_mode:
+            url = "https://dev-identity.haypost.am/api/Connect/Token"
+
+        try:
+            response = lib.request(
+                url=url,
+                method="POST",
+                data=json.dumps(
+                    {
+                        "username": self.username,
+                        "password": self.password,
+                        "customerType": self.customer_type,
+                    }
+                ),
+                proxy=self.proxy,
+                headers={"Content-Type": "application/json"},
+            )
+
+            return lib.to_dict(response).get("accessToken")
+
+        except Exception as e:
+            print(f"Request failed: {e}")
+            return None

karrio/schemas/hay_post/auth_request.py

@@ -0,0 +1,12 @@
+import attr
+import jstruct
+import typing
+
+
+@attr.s(auto_attribs=True)
+class AuthRequestType:
+    username: typing.Optional[str] = None
+    password: typing.Optional[str] = None
+    customerType: typing.Optional[int] = None
+    deviceId: typing.Optional[str] = None
+    fcmToken: typing.Optional[str] = None

karrio/schemas/hay_post/auth_response.py

@@ -0,0 +1,11 @@
+import attr
+import jstruct
+import typing
+
+
+@attr.s(auto_attribs=True)
+class AuthResponseType:
+    accessToken: typing.Optional[str] = None
+    expDate: typing.Optional[int] = None
+    refreshToken: typing.Optional[str] = None
+    navigation: typing.Optional[int] = None

karrio/schemas/hay_post/error.py

@@ -0,0 +1,9 @@
+import attr
+import jstruct
+import typing
+
+
+@attr.s(auto_attribs=True)
+class ErrorType:
+    key: typing.Optional[str] = None
+    name: typing.Optional[str] = None

karrio/schemas/hay_post/order_create_request.py

@@ -0,0 +1,36 @@
+import attr
+import jstruct
+import typing
+
+
+@attr.s(auto_attribs=True)
+class ReceiverInfoType:
+    companyName: typing.Optional[str] = None
+    firstName: typing.Optional[str] = None
+    lastName: typing.Optional[str] = None
+    phoneNumber: typing.Optional[str] = None
+    email: typing.Optional[str] = None
+
+
+@attr.s(auto_attribs=True)
+class NAddressType:
+    countryId: typing.Optional[int] = None
+    provinceStateId: typing.Optional[int] = None
+    cityVillage: typing.Optional[str] = None
+    street: typing.Optional[str] = None
+    building: typing.Optional[int] = None
+    apartment: typing.Optional[int] = None
+    postalCode: typing.Optional[str] = None
+    receiverInfo: typing.Optional[ReceiverInfoType] = jstruct.JStruct[ReceiverInfoType]
+
+
+@attr.s(auto_attribs=True)
+class OrderCreateRequestType:
+    customerId: typing.Optional[int] = None
+    serviceCategoryDirectionId: typing.Optional[int] = None
+    weight: typing.Optional[int] = None
+    comment: typing.Optional[str] = None
+    returnRegisteredAddress: typing.Optional[bool] = None
+    destinationAddress: typing.Optional[NAddressType] = jstruct.JStruct[NAddressType]
+    returnAddress: typing.Optional[NAddressType] = jstruct.JStruct[NAddressType]
+    additionalServices: typing.Optional[typing.List[int]] = None

karrio/schemas/hay_post/order_create_response.py

@@ -0,0 +1,12 @@
+import attr
+import jstruct
+import typing
+
+
+@attr.s(auto_attribs=True)
+class OrderCreateResponseType:
+    id: typing.Optional[int] = None
+    barcode: typing.Optional[str] = None
+    revertOrderId: typing.Optional[int] = None
+    revertBarcode: typing.Optional[str] = None
+    postalcode: typing.Any = None

karrio/schemas/hay_post/order_tracking_request.py

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

karrio/schemas/hay_post/order_tracking_response.py

@@ -0,0 +1,103 @@
+import attr
+import jstruct
+import typing
+
+
+@attr.s(auto_attribs=True)
+class AdditionalServiceType:
+    id: typing.Optional[int] = None
+    name: typing.Optional[str] = None
+    fee: typing.Optional[int] = None
+    key: typing.Optional[str] = None
+    relationIndexId: typing.Optional[int] = None
+    isActive: typing.Optional[bool] = None
+
+
+@attr.s(auto_attribs=True)
+class LegalTypeObjectType:
+    id: typing.Optional[int] = None
+    name: typing.Optional[str] = None
+
+
+@attr.s(auto_attribs=True)
+class CustomerType:
+    customerId: typing.Optional[int] = None
+    firstName: typing.Optional[str] = None
+    lastName: typing.Optional[str] = None
+    phone: typing.Any = None
+    legalType: typing.Optional[LegalTypeObjectType] = jstruct.JStruct[LegalTypeObjectType]
+    documents: typing.Optional[typing.List[typing.Any]] = None
+    companyName: typing.Any = None
+
+
+@attr.s(auto_attribs=True)
+class OrderType:
+    id: typing.Optional[int] = None
+    customerId: typing.Optional[int] = None
+    trackingId: typing.Optional[str] = None
+    amount: typing.Optional[int] = None
+    weight: typing.Optional[int] = None
+    stateId: typing.Optional[int] = None
+    comment: typing.Optional[str] = None
+    service: typing.Optional[LegalTypeObjectType] = jstruct.JStruct[LegalTypeObjectType]
+    category: typing.Optional[LegalTypeObjectType] = jstruct.JStruct[LegalTypeObjectType]
+    transactionId: typing.Any = None
+    bundle: typing.Any = None
+    shipment: typing.Any = None
+    createDate: typing.Optional[str] = None
+    isVerified: typing.Optional[bool] = None
+    recaddress: typing.Any = None
+    locationId: typing.Any = None
+    codAmount: typing.Any = None
+    paymentMethodId: typing.Optional[int] = None
+    isInternational: typing.Optional[bool] = None
+    partner: typing.Any = None
+
+
+@attr.s(auto_attribs=True)
+class ReceiverInfoType:
+    companyName: typing.Optional[str] = None
+    firstName: typing.Optional[str] = None
+    lastName: typing.Optional[str] = None
+    phoneNumber: typing.Optional[str] = None
+    email: typing.Optional[str] = None
+    nickname: typing.Any = None
+
+
+@attr.s(auto_attribs=True)
+class NAddressType:
+    country: typing.Optional[LegalTypeObjectType] = jstruct.JStruct[LegalTypeObjectType]
+    provinceState: typing.Optional[LegalTypeObjectType] = jstruct.JStruct[LegalTypeObjectType]
+    cityVillage: typing.Optional[LegalTypeObjectType] = jstruct.JStruct[LegalTypeObjectType]
+    street: typing.Optional[LegalTypeObjectType] = jstruct.JStruct[LegalTypeObjectType]
+    building: typing.Optional[LegalTypeObjectType] = jstruct.JStruct[LegalTypeObjectType]
+    apartment: typing.Optional[LegalTypeObjectType] = jstruct.JStruct[LegalTypeObjectType]
+    postalCode: typing.Optional[str] = None
+    address: typing.Any = None
+    isHomeDelivery: typing.Optional[bool] = None
+    isDeliveryPaid: typing.Optional[bool] = None
+    deliveryDate: typing.Optional[str] = None
+    receiverInfo: typing.Optional[ReceiverInfoType] = jstruct.JStruct[ReceiverInfoType]
+    factreceiverInfo: typing.Any = None
+
+
+@attr.s(auto_attribs=True)
+class OrderStateHistoryType:
+    id: typing.Optional[int] = None
+    orderId: typing.Optional[int] = None
+    stateId: typing.Optional[int] = None
+    createDate: typing.Optional[str] = None
+    userId: typing.Optional[int] = None
+    isActive: typing.Optional[bool] = None
+
+
+@attr.s(auto_attribs=True)
+class OrderTrackingResponseType:
+    order: typing.Optional[OrderType] = jstruct.JStruct[OrderType]
+    info: typing.Any = None
+    orderDestinationAddress: typing.Optional[NAddressType] = jstruct.JStruct[NAddressType]
+    returnAddress: typing.Optional[NAddressType] = jstruct.JStruct[NAddressType]
+    customer: typing.Optional[CustomerType] = jstruct.JStruct[CustomerType]
+    orderStateHistories: typing.Optional[typing.List[OrderStateHistoryType]] = jstruct.JList[OrderStateHistoryType]
+    additionalServices: typing.Optional[typing.List[AdditionalServiceType]] = jstruct.JList[AdditionalServiceType]
+    rejectedOrders: typing.Optional[typing.List[typing.Any]] = None

karrio/schemas/hay_post/tariff_request.py

@@ -0,0 +1,80 @@
+import attr
+import jstruct
+import typing
+
+
+@attr.s(auto_attribs=True)
+class ReceiverInfoType:
+    companyName: typing.Optional[str] = None
+    firstName: typing.Optional[str] = None
+    lastName: typing.Optional[str] = None
+    phoneNumber: typing.Optional[str] = None
+    email: typing.Optional[str] = None
+    nickname: typing.Optional[str] = None
+
+
+@attr.s(auto_attribs=True)
+class NAddressType:
+    countryId: typing.Optional[int] = None
+    provinceStateId: typing.Optional[int] = None
+    provinceState: typing.Optional[str] = None
+    cityVillageId: typing.Optional[int] = None
+    cityVillage: typing.Optional[str] = None
+    streetId: typing.Optional[int] = None
+    street: typing.Optional[str] = None
+    buildingId: typing.Optional[int] = None
+    building: typing.Optional[str] = None
+    apartment: typing.Optional[str] = None
+    apartmentId: typing.Optional[int] = None
+    address: typing.Optional[str] = None
+    postalCode: typing.Optional[str] = None
+    deliveryDate: typing.Optional[str] = None
+    receiverInfo: typing.Optional[ReceiverInfoType] = jstruct.JStruct[ReceiverInfoType]
+
+
+@attr.s(auto_attribs=True)
+class CodType:
+    amount: typing.Optional[int] = None
+    bank: typing.Optional[str] = None
+    accountNumber: typing.Optional[str] = None
+
+
+@attr.s(auto_attribs=True)
+class EnclosureEnclosureType:
+    description: typing.Optional[str] = None
+    hsCode: typing.Optional[str] = None
+    quantity: typing.Optional[int] = None
+    weight: typing.Optional[int] = None
+    amount: typing.Optional[int] = None
+    countryOfOrigin: typing.Optional[str] = None
+
+
+@attr.s(auto_attribs=True)
+class OrderInfoEnclosureType:
+    enclosures: typing.Optional[typing.List[EnclosureEnclosureType]] = jstruct.JList[EnclosureEnclosureType]
+    enclosureTypeId: typing.Optional[int] = None
+
+
+@attr.s(auto_attribs=True)
+class OrderInfoType:
+    valuedAmount: typing.Optional[int] = None
+    valuedAmountCurrency: typing.Optional[int] = None
+    enclosure: typing.Optional[typing.List[OrderInfoEnclosureType]] = jstruct.JList[OrderInfoEnclosureType]
+    cod: typing.Optional[CodType] = jstruct.JStruct[CodType]
+
+
+@attr.s(auto_attribs=True)
+class TariffRequestElementType:
+    customerId: typing.Optional[int] = None
+    serviceCategoryDirectionId: typing.Optional[int] = None
+    weight: typing.Optional[int] = None
+    totalPrice: typing.Optional[int] = None
+    currencyId: typing.Optional[int] = None
+    comment: typing.Optional[str] = None
+    returnRegisteredAddress: typing.Optional[bool] = None
+    partner: typing.Optional[int] = None
+    externalId: typing.Optional[str] = None
+    destinationAddress: typing.Optional[NAddressType] = jstruct.JStruct[NAddressType]
+    returnAddress: typing.Optional[NAddressType] = jstruct.JStruct[NAddressType]
+    orderInfo: typing.Optional[OrderInfoType] = jstruct.JStruct[OrderInfoType]
+    additionalServices: typing.Optional[typing.List[int]] = None

karrio_hay_post-2025.5rc1.dist-info/METADATA

@@ -0,0 +1,86 @@
+Metadata-Version: 2.4
+Name: karrio_hay_post
+Version: 2025.5rc1
+Summary: Karrio - HayPost 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.hay_post
+
+This package is a HayPost extension of the [karrio](https://pypi.org/project/karrio) multi carrier shipping SDK.
+
+## Requirements
+
+`Python 3.7+`
+
+## Installation
+
+```bash
+pip install karrio.hay_post
+```
+
+## Usage
+
+```python
+import karrio.sdk as karrio
+from karrio.mappers.hay_post.settings import Settings
+
+# Initialize a carrier gateway
+hay_post = karrio.gateway["hay_post"].create(
+    Settings(
+        ...
+    )
+)
+```
+
+For test mode, you need to add your proxy or use a static IP address that HayPost has whitelisted.
+Additionally, you need to connect with HayPost managers to obtain test and production
+accounts. [Haypost ContactUs](https://www.haypost.am/en/contact-us)
+
+Check the [Karrio Mutli-carrier SDK docs](https://docs.karrio.io) for Shipping API requests
+
+## Additional information
+
+### Services
+
+   * letter_ordered
+   * letter_simple
+   * letter_valued
+   * package_ordered
+   * package_simple
+   * package_valued
+   * parcel_simple
+   * parcel_valued
+   * postcard_ordered
+   * postcard_simple
+   * sekogram_simple
+   * sprint_simple
+   * yes_ordered_value
+
+### Currencies
+
+   * RUB
+   * USD
+   * EUR
+   * AMD
+
+### Additional Services as Option
+
+   * notification
+   * ordered_packaging
+   * pick_up
+   * postmen_delivery_value
+   * delivery
+   * international_notification
+   * domestic_sms
+   * international_sms
+
+### Note
+* To obtain rates, you first need to configure them in the Carrier Configurations section (Services and Options).

karrio_hay_post-2025.5rc1.dist-info/RECORD

@@ -0,0 +1,27 @@
+karrio/mappers/hay_post/__init__.py,sha256=1KDqsn4fjq_tSOtOpLMPRCY9ox0PmGKSPaET8HVebPs,153
+karrio/mappers/hay_post/mapper.py,sha256=uj_CU-C4eq_zh17PnjhKeH3W0G5nUJagRovsKjn3sH4,1522
+karrio/mappers/hay_post/proxy.py,sha256=1AT6Dgpz9Yc2Gns0ft4l_tA7z2OE3STLmRAmktDtSYw,2186
+karrio/mappers/hay_post/settings.py,sha256=FOi3lE_7mZMmiid-xxhzM2RbLcQbSslEf8ZgIghoHz4,530
+karrio/plugins/hay_post/__init__.py,sha256=QWyl2q-cdQkKMG-LRIZwvNR-_6hwlr_FH2Ku0nkzzFk,565
+karrio/providers/hay_post/__init__.py,sha256=kgo_OSPJ2IZQ8-gv94VuUzCmOd-lg-2LInid3EaLxEY,335
+karrio/providers/hay_post/error.py,sha256=WYD8M-o7jcsyXfpaNa0xO5k-UY0J8x7V7F_lVf3IeqM,845
+karrio/providers/hay_post/rate.py,sha256=_H_WR2YMCRN9ENpSzxwv8VqYkdMYsD0L_YZ9_qFq8a0,3778
+karrio/providers/hay_post/tracking.py,sha256=EwOTybLxitEfcdFq2Mus_fPMv3PyEQK_tITJNsS2Evs,2967
+karrio/providers/hay_post/units.py,sha256=-EZFSjCQ-VeimynqzwSkc40v-XTbvHLrEIlccw_AY_4,4811
+karrio/providers/hay_post/utils.py,sha256=7aukNJcwzvjx4027p7XMwBTdiGXeZOyuFkGpSqRBGIA,1733
+karrio/providers/hay_post/shipment/__init__.py,sha256=Y7q1mUiD5sRy9tWuXpIGqPcDPMLodmOy4-QJ3xpAJCo,110
+karrio/providers/hay_post/shipment/create.py,sha256=cfgG1t0yV1BH1QJN_xXHqlt5y_6vPgyBWPEjIbfcRTU,3625
+karrio/schemas/hay_post/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+karrio/schemas/hay_post/auth_request.py,sha256=_GEoPHr590QEy3o4dOA3EhpRRumSLxuhyQn4WcHU2W8,307
+karrio/schemas/hay_post/auth_response.py,sha256=vTpl-Lv4FGQTmL3e2G9JkoMoiUdmocMoF7H7bFm-9d0,270
+karrio/schemas/hay_post/error.py,sha256=mSwJo38_ehtXr8Er7rGhbCP9k55wbCae4aEv4emApXA,162
+karrio/schemas/hay_post/order_create_request.py,sha256=MfLYbWKxKTHalG5Tl_6jfGKOLRGenBXImuS3EFK6D7U,1285
+karrio/schemas/hay_post/order_create_response.py,sha256=nhpjb5pbP8WBQ3z9w2y7fcfFeLlsC3y9uSLhU8v8KDg,306
+karrio/schemas/hay_post/order_tracking_request.py,sha256=m8RBuPzaA7h7x_GQzFdY6kJOHq4awSXVT2GTyHMpyAA,150
+karrio/schemas/hay_post/order_tracking_response.py,sha256=axk2Tny9yRfrSOF7_5FeuVzgLIDIcH69Fohjvxa8UoM,4043
+karrio/schemas/hay_post/tariff_request.py,sha256=lct5WzV7wnFAcjw9Yuls9WDgvw0LQtJfb5OtjbyVa7g,2913
+karrio_hay_post-2025.5rc1.dist-info/METADATA,sha256=8AsnrCRaOUJPSmAkzbn2F9B0vlcHfvYrChc8Goq06wk,1937
+karrio_hay_post-2025.5rc1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+karrio_hay_post-2025.5rc1.dist-info/entry_points.txt,sha256=XF98wJWJnsSYHoobsm-_5qos_8oHR38gRV8PHtlXqog,61
+karrio_hay_post-2025.5rc1.dist-info/top_level.txt,sha256=FZCY8Nwft8oEGHdl--xku8P3TrnOxu5dETEU_fWpRSM,20
+karrio_hay_post-2025.5rc1.dist-info/RECORD,,

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

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

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

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