karrio-sapient 2025.5rc1__py3-none-any.whl

karrio/providers/sapient/utils.py

@@ -0,0 +1,122 @@
+import base64
+import datetime
+import karrio.lib as lib
+import karrio.core as core
+import karrio.core.errors as errors
+
+
+SapientCarrierCode = lib.units.create_enum(
+    "SapientCarrierCode",
+    ["DX", "EVRI", "RM", "UPS", "YODEL"],
+)
+
+
+class Settings(core.Settings):
+    """SAPIENT connection settings."""
+
+    # Add carrier specific api connection properties here
+    client_id: str
+    client_secret: str
+    shipping_account_id: str
+    sapient_carrier_code: SapientCarrierCode = "RM"  # type: ignore
+
+    @property
+    def carrier_name(self):
+        return "sapient"
+
+    @property
+    def server_url(self):
+        return "https://api.intersoftsapient.net"
+
+    # """uncomment the following code block to expose a carrier tracking url."""
+    # @property
+    # def tracking_url(self):
+    #     return "https://www.carrier.com/tracking?tracking-id={}"
+
+    # """uncomment the following code block to implement the Basic auth."""
+    # @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,
+        )
+
+    """uncomment the following code block to implement the oauth login."""
+
+    @property
+    def access_token(self):
+        """Retrieve the access_token using the client_id|client_secret pair
+        or collect it from the cache if an unexpired access_token exist.
+        """
+        cache_key = f"{self.carrier_name}|{self.client_id}|{self.client_secret}"
+        now = datetime.datetime.now() + datetime.timedelta(minutes=30)
+
+        auth = self.connection_cache.get(cache_key) or {}
+        token = auth.get("access_token")
+        expiry = lib.to_date(auth.get("expiry"), current_format="%Y-%m-%d %H:%M:%S")
+
+        if token is not None and expiry is not None and expiry > now:
+            return token
+
+        self.connection_cache.set(cache_key, lambda: login(self))
+        new_auth = self.connection_cache.get(cache_key)
+
+        return new_auth["access_token"]
+
+
+"""uncomment the following code block to implement the oauth login."""
+
+
+def login(settings: Settings):
+    import karrio.providers.sapient.error as error
+
+    result = lib.request(
+        url=f"https://authentication.intersoftsapient.net/connect/token",
+        method="POST",
+        headers={
+            "content-Type": "application/x-www-form-urlencoded",
+            "user-agent": "Karrio/1.0",
+        },
+        data=lib.to_query_string(
+            dict(
+                grant_type="client_credentials",
+                client_id=settings.client_id,
+                client_secret=settings.client_secret,
+            )
+        ),
+        on_error=parse_error_response,
+    )
+
+    response = lib.to_dict(result)
+    messages = error.parse_error_response(response, settings)
+
+    if any(messages):
+        raise errors.ParsedMessagesError(messages)
+
+    expiry = datetime.datetime.now() + datetime.timedelta(
+        seconds=float(response.get("expires_in", 0))
+    )
+    return {**response, "expiry": lib.fdatetime(expiry)}
+
+
+class ConnectionConfig(lib.Enum):
+    service_level = lib.OptionEnum("service_level", str)
+    shipping_options = lib.OptionEnum("shipping_options", list)
+    shipping_services = lib.OptionEnum("shipping_services", list)
+
+
+def parse_error_response(response):
+    """Parse the error response from the SAPIENT API."""
+    content = lib.failsafe(lambda: lib.decode(response.read()))
+
+    if any(content or ""):
+        return content
+
+    return lib.to_json(
+        dict(Errors=[dict(ErrorCode=str(response.code), Message=response.reason)])
+    )

karrio/schemas/sapient/error_response.py

@@ -0,0 +1,16 @@
+import attr
+import jstruct
+import typing
+
+
+@attr.s(auto_attribs=True)
+class ErrorType:
+    Message: typing.Optional[str] = None
+    Cause: typing.Optional[str] = None
+    ErrorCode: typing.Optional[str] = None
+
+
+@attr.s(auto_attribs=True)
+class ErrorResponseType:
+    Message: typing.Optional[str] = None
+    Errors: typing.Optional[typing.List[ErrorType]] = jstruct.JList[ErrorType]

karrio/schemas/sapient/pickup_request.py

@@ -0,0 +1,10 @@
+import attr
+import jstruct
+import typing
+
+
+@attr.s(auto_attribs=True)
+class PickupRequestType:
+    SlotReservationId: typing.Optional[str] = None
+    SlotDate: typing.Optional[str] = None
+    BringMyLabel: typing.Optional[bool] = None

karrio/schemas/sapient/pickup_response.py

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

karrio/schemas/sapient/shipment_requests.py

@@ -0,0 +1,125 @@
+import attr
+import jstruct
+import typing
+
+
+@attr.s(auto_attribs=True)
+class ServiceEnhancementType:
+    Code: typing.Optional[str] = None
+    SafeplaceLocation: typing.Optional[str] = None
+
+
+@attr.s(auto_attribs=True)
+class CarrierSpecificsType:
+    ServiceLevel: typing.Optional[str] = None
+    EbayVtn: typing.Optional[str] = None
+    ServiceEnhancements: typing.Optional[typing.List[ServiceEnhancementType]] = jstruct.JList[ServiceEnhancementType]
+
+
+@attr.s(auto_attribs=True)
+class CustomsType:
+    ReasonForExport: typing.Optional[str] = None
+    Incoterms: typing.Optional[str] = None
+    PreRegistrationNumber: typing.Optional[str] = None
+    PreRegistrationType: typing.Optional[str] = None
+    ShippingCharges: typing.Optional[float] = None
+    OtherCharges: typing.Optional[int] = None
+    QuotedLandedCost: typing.Optional[float] = None
+    InvoiceNumber: typing.Optional[str] = None
+    InvoiceDate: typing.Optional[str] = None
+    ExportLicenceRequired: typing.Optional[bool] = None
+    Airn: typing.Optional[str] = None
+
+
+@attr.s(auto_attribs=True)
+class AddressType:
+    ContactName: typing.Optional[str] = None
+    CompanyName: typing.Optional[str] = None
+    ContactEmail: typing.Optional[str] = None
+    ContactPhone: typing.Optional[str] = None
+    Line1: typing.Optional[str] = None
+    Line2: typing.Optional[str] = None
+    Line3: typing.Optional[str] = None
+    Town: typing.Optional[str] = None
+    Postcode: typing.Optional[str] = None
+    County: typing.Optional[str] = None
+    CountryCode: typing.Optional[str] = None
+
+
+@attr.s(auto_attribs=True)
+class DestinationType:
+    Address: typing.Optional[AddressType] = jstruct.JStruct[AddressType]
+    EoriNumber: typing.Optional[str] = None
+    VatNumber: typing.Optional[str] = None
+
+
+@attr.s(auto_attribs=True)
+class ItemType:
+    SkuCode: typing.Optional[str] = None
+    PackageOccurrence: typing.Optional[int] = None
+    Quantity: typing.Optional[int] = None
+    Description: typing.Optional[str] = None
+    Value: typing.Optional[float] = None
+    Weight: typing.Optional[float] = None
+    HSCode: typing.Optional[str] = None
+    CountryOfOrigin: typing.Optional[str] = None
+
+
+@attr.s(auto_attribs=True)
+class DimensionsType:
+    Length: typing.Optional[int] = None
+    Width: typing.Optional[int] = None
+    Height: typing.Optional[int] = None
+
+
+@attr.s(auto_attribs=True)
+class PackageType:
+    PackageType: typing.Optional[str] = None
+    PackageOccurrence: typing.Optional[int] = None
+    DeclaredWeight: typing.Optional[float] = None
+    Dimensions: typing.Optional[DimensionsType] = jstruct.JStruct[DimensionsType]
+    DeclaredValue: typing.Optional[float] = None
+
+
+@attr.s(auto_attribs=True)
+class ReturnToSenderType:
+    Address: typing.Optional[AddressType] = jstruct.JStruct[AddressType]
+
+
+@attr.s(auto_attribs=True)
+class ShipmentInformationType:
+    ContentType: typing.Optional[str] = None
+    Action: typing.Optional[str] = None
+    LabelFormat: typing.Optional[str] = None
+    ServiceCode: typing.Optional[str] = None
+    DescriptionOfGoods: typing.Optional[str] = None
+    ShipmentDate: typing.Optional[str] = None
+    CurrencyCode: typing.Optional[str] = None
+    WeightUnitOfMeasure: typing.Optional[str] = None
+    DimensionsUnitOfMeasure: typing.Optional[str] = None
+    ContainerId: typing.Optional[str] = None
+    DeclaredWeight: typing.Optional[float] = None
+    BusinessTransactionType: typing.Optional[str] = None
+
+
+@attr.s(auto_attribs=True)
+class ShipperType:
+    Address: typing.Optional[AddressType] = jstruct.JStruct[AddressType]
+    ShippingAccountId: typing.Optional[str] = None
+    ShippingLocationId: typing.Optional[str] = None
+    Reference1: typing.Optional[str] = None
+    DepartmentNumber: typing.Optional[str] = None
+    EoriNumber: typing.Optional[str] = None
+    VatNumber: typing.Optional[str] = None
+
+
+@attr.s(auto_attribs=True)
+class ShipmentRequestType:
+    ShipmentInformation: typing.Optional[ShipmentInformationType] = jstruct.JStruct[ShipmentInformationType]
+    Shipper: typing.Optional[ShipperType] = jstruct.JStruct[ShipperType]
+    Destination: typing.Optional[DestinationType] = jstruct.JStruct[DestinationType]
+    CarrierSpecifics: typing.Optional[CarrierSpecificsType] = jstruct.JStruct[CarrierSpecificsType]
+    ReturnToSender: typing.Optional[ReturnToSenderType] = jstruct.JStruct[ReturnToSenderType]
+    Packages: typing.Optional[typing.List[PackageType]] = jstruct.JList[PackageType]
+    Items: typing.Optional[typing.List[ItemType]] = jstruct.JList[ItemType]
+    Customs: typing.Optional[CustomsType] = jstruct.JStruct[CustomsType]

karrio/schemas/sapient/shipment_response.py

@@ -0,0 +1,24 @@
+import attr
+import jstruct
+import typing
+
+
+@attr.s(auto_attribs=True)
+class CarrierDetailsType:
+    UniqueId: typing.Optional[str] = None
+
+
+@attr.s(auto_attribs=True)
+class PackageType:
+    CarrierDetails: typing.Optional[CarrierDetailsType] = jstruct.JStruct[CarrierDetailsType]
+    ShipmentId: typing.Optional[str] = None
+    PackageOccurrence: typing.Optional[int] = None
+    TrackingNumber: typing.Optional[str] = None
+    CarrierTrackingUrl: typing.Optional[str] = None
+
+
+@attr.s(auto_attribs=True)
+class ShipmentResponseType:
+    Labels: typing.Optional[str] = None
+    LabelFormat: typing.Optional[str] = None
+    Packages: typing.Optional[typing.List[PackageType]] = jstruct.JList[PackageType]

karrio_sapient-2025.5rc1.dist-info/METADATA

@@ -0,0 +1,45 @@
+Metadata-Version: 2.4
+Name: karrio_sapient
+Version: 2025.5rc1
+Summary: Karrio - SAPIENT 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.sapient
+
+This package is a SAPIENT extension of the [karrio](https://pypi.org/project/karrio) multi carrier shipping SDK.
+
+## Requirements
+
+`Python 3.7+`
+
+## Installation
+
+```bash
+pip install karrio.sapient
+```
+
+## Usage
+
+```python
+import karrio.sdk as karrio
+from karrio.mappers.sapient.settings import Settings
+
+
+# Initialize a carrier gateway
+sapient = karrio.gateway["sapient"].create(
+    Settings(
+        ...
+    )
+)
+```
+
+Check the [Karrio Mutli-carrier SDK docs](https://docs.karrio.io) for Shipping API requests

karrio_sapient-2025.5rc1.dist-info/RECORD

@@ -0,0 +1,27 @@
+karrio/mappers/sapient/__init__.py,sha256=I4fWpxOlRnfyBNjL0LxvQlpwOk2sjrZhgtCO2XvSJVk,149
+karrio/mappers/sapient/mapper.py,sha256=BDU1L2QW1W-0e8eYcgSf-eLkj5o7SS4kje-WObnZSUg,2866
+karrio/mappers/sapient/proxy.py,sha256=vzfErbI6i5_uVA5UUIjCyKpxNeZu6eupDpSkvQT-P9E,3537
+karrio/mappers/sapient/settings.py,sha256=a5xE-umxBbP1sHaN6SKkbt-ftsmx9pnWkMEUIeAhVLY,1095
+karrio/plugins/sapient/__init__.py,sha256=_4xkqTPpUoq8KixCdNqNxcMVH52s5xH6L-s9c5fongE,537
+karrio/providers/sapient/__init__.py,sha256=Zu7FIaPsCzXgIsrmEtluHQJSj3UnFDpz-oiB93P-xK0,476
+karrio/providers/sapient/error.py,sha256=hkpy86gWOjKLNhtmBoe7NkHq330kRqrtgDxsspLaxGQ,870
+karrio/providers/sapient/units.py,sha256=1rCsLoMjVwg7xNhtCD6uTeuI310Bc-RXLTCYUb-rfqQ,34560
+karrio/providers/sapient/utils.py,sha256=31dgSqot8k3gj_kpUfitKMrUQtuNtVzkzEW_cAKRkUQ,3763
+karrio/providers/sapient/pickup/__init__.py,sha256=qT64wGr8J6pkLNa9Y0Zou5mYshoI7W-R0Pp7nWEhQ08,296
+karrio/providers/sapient/pickup/cancel.py,sha256=0laDCfdhjOYHpOEN7l6u1o79nexaxT8GXMM5pJU3Xow,1763
+karrio/providers/sapient/pickup/create.py,sha256=5S-h9qQuDFqxvqrmd2l0-SGQMi86O38sfjfqRVPGgo8,2776
+karrio/providers/sapient/pickup/update.py,sha256=rG4du0Ey_w3AaA2db46nKLMPKTCYokZlfofRQwZ83P0,2796
+karrio/providers/sapient/shipment/__init__.py,sha256=DMPIljx1L1FvlatOITGSsfSGovv-NLW7ydT7SDlDIEE,231
+karrio/providers/sapient/shipment/cancel.py,sha256=4p1KyMmyasy5wKCfVGGW2I0AWClbX5FbjhhkYD0zymc,1698
+karrio/providers/sapient/shipment/create.py,sha256=ZmKW4m0LqErrQbFQoQuv3eA6hIDpgfZ14gIrQlHHsQc,9794
+karrio/schemas/sapient/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+karrio/schemas/sapient/error_response.py,sha256=43gmiRdi5y2I1qn1OfuR9f30JTld6I5lgtzpjIOEUpQ,384
+karrio/schemas/sapient/pickup_request.py,sha256=gzZZ3Bxr_pYWxw28vDRr-aDgtzJIQptUkaTEzXhX96g,235
+karrio/schemas/sapient/pickup_response.py,sha256=xcl3ofB2L2RNksMSRccvFbBdBcK1hVDDPVB-oAu4I54,195
+karrio/schemas/sapient/shipment_requests.py,sha256=roKQ4iFkm6BKzI_b8TL39ZcsKWU61LVN7oRh_lyb75k,4574
+karrio/schemas/sapient/shipment_response.py,sha256=457ULt-exxAJ0Drqn2Pnj9pl_4JWMZ-cesuJW9NWBAs,702
+karrio_sapient-2025.5rc1.dist-info/METADATA,sha256=Wuin4NcW9GInx033Z4yfpaEWuH8kcLC9cTqoDl7cRbk,992
+karrio_sapient-2025.5rc1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+karrio_sapient-2025.5rc1.dist-info/entry_points.txt,sha256=rPF-WjVKk-3suhX4-zi9hTkwr0Qxb4ZW-Tjoyzi_Cy8,59
+karrio_sapient-2025.5rc1.dist-info/top_level.txt,sha256=FZCY8Nwft8oEGHdl--xku8P3TrnOxu5dETEU_fWpRSM,20
+karrio_sapient-2025.5rc1.dist-info/RECORD,,

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

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

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

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