karrio 2023.5.1__py3-none-any.whl → 2025.5rc1__py3-none-any.whl

karrio/core/models.py

@@ -1,4 +1,6 @@
 """Karrio Unified model definitions module."""
+
+from unicodedata import category
 import attr
 from typing import List, Dict, Any, Union
 from jstruct import JList, JStruct, REQUIRED
@@ -23,6 +25,7 @@ class Address:
     address_line1: str = ""
     address_line2: str = None
     street_number: str = None
+    suite: str = None
 
     federal_tax_id: str = None
     state_tax_id: str = None
@@ -43,6 +46,7 @@ class Commodity:
     value_amount: float = None
     value_currency: str = None
     origin_country: str = None
+    category: str = None
 
     metadata: Dict = {}
 
@@ -124,6 +128,7 @@ class ShipmentRequest:
 
     payment: Payment = JStruct[Payment]
     customs: Customs = JStruct[Customs]
+    return_address: Address = JStruct[Address]
     billing_address: Address = JStruct[Address]
 
     options: Dict = {}
@@ -151,6 +156,11 @@ class RateRequest:
     recipient: Address = JStruct[Address, REQUIRED]
     parcels: List[Parcel] = JList[Parcel, REQUIRED]
 
+    payment: Payment = JStruct[Payment]
+    customs: Customs = JStruct[Customs]
+    return_address: Address = JStruct[Address]
+    billing_address: Address = JStruct[Address]
+
     services: List[str] = []
     options: Dict = {}
     reference: str = ""
@@ -176,10 +186,13 @@ class PickupRequest:
     address: Address = JStruct[Address, REQUIRED]
 
     parcels: List[Parcel] = JList[Parcel]
-    instruction: str = None
+    shipment_identifiers: List[str] = []
     package_location: str = None
+    instruction: str = None
     options: Dict = {}
 
+    metadata: Dict = {}
+
 
 @attr.s(auto_attribs=True)
 class PickupUpdateRequest:
@@ -192,8 +205,9 @@ class PickupUpdateRequest:
     address: Address = JStruct[Address, REQUIRED]
 
     parcels: List[Parcel] = JList[Parcel]
-    instruction: str = None
+    shipment_identifiers: List[str] = []
     package_location: str = None
+    instruction: str = None
     options: Dict = {}
 
 
@@ -206,6 +220,7 @@ class PickupCancelRequest:
     address: Address = JStruct[Address]
     pickup_date: str = None
     reason: str = None
+    options: Dict = {}
 
 
 @attr.s(auto_attribs=True)
@@ -215,6 +230,18 @@ class AddressValidationRequest:
     address: Address = JStruct[Address, REQUIRED]
 
 
+@attr.s(auto_attribs=True)
+class ManifestRequest:
+    """manifest request unified data type."""
+
+    shipment_identifiers: List[str]
+    address: Address = JStruct[Address, REQUIRED]
+
+    reference: str = None
+    metadata: Dict = {}
+    options: Dict = {}
+
+
 @attr.s(auto_attribs=True)
 class Message:
     """Karrio unified Message data type."""
@@ -223,6 +250,7 @@ class Message:
     carrier_id: str
     message: Union[str, Any] = None
     code: str = None
+    level: str = None
     details: Dict = None
 
 
@@ -301,6 +329,14 @@ class TrackingInfo:
     source: str = None
 
 
+@attr.s(auto_attribs=True)
+class Images:
+    """Karrio unified tracker images data type."""
+
+    delivery_image: str = None
+    signature_image: str = None
+
+
 @attr.s(auto_attribs=True)
 class TrackingDetails:
     """Karrio unified tracking details data type."""
@@ -309,6 +345,7 @@ class TrackingDetails:
     carrier_id: str
     tracking_number: str
     events: List[TrackingEvent] = JList[TrackingEvent, REQUIRED]
+    images: Images = JStruct[Images]
     estimated_delivery: str = None
     info: TrackingInfo = None
     delivered: bool = None
@@ -318,13 +355,13 @@ class TrackingDetails:
 
 @attr.s(auto_attribs=True)
 class Documents:
-    """Karrio unified shipment details data type."""
+    """Karrio unified shipment documents details data type."""
 
     label: str
-    zpl_label: str = None
-    pdf_label: str = None
 
     invoice: str = None
+    zpl_label: str = None
+    pdf_label: str = None
 
 
 @attr.s(auto_attribs=True)
@@ -353,6 +390,25 @@ class PickupDetails:
     pickup_charge: ChargeDetails = JStruct[ChargeDetails]
     ready_time: str = None
     closing_time: str = None
+    meta: dict = None
+    id: str = None
+
+
+@attr.s(auto_attribs=True)
+class ManifestDocument:
+    """Karrio unified manifest document details data type."""
+
+    manifest: str = None
+
+
+@attr.s(auto_attribs=True)
+class ManifestDetails:
+    """Karrio unified manifest details data type."""
+
+    carrier_name: str
+    carrier_id: str
+    doc: ManifestDocument = JStruct[ManifestDocument]
+    meta: dict = None
     id: str = None
 
 
@@ -389,6 +445,7 @@ class ServiceZone:
 
     # Location
     cities: List[str] = []
+    postal_codes: List[str] = []
     country_codes: List[str] = []
 
 
@@ -398,6 +455,7 @@ class ServiceLevel:
 
     service_name: str
     service_code: str
+    carrier_service_code: str = None
     description: str = ""
     active: bool = True
     id: str = None
@@ -425,6 +483,8 @@ class ServiceLevel:
     transit_days: int = None
     transit_time: float = None
 
+    metadata: Dict = {}
+
 
 @attr.s(auto_attribs=True)
 class LabelTemplate:
@@ -466,6 +526,7 @@ class DocumentUploadRequest:
 
     document_files: List[DocumentFile] = JList[DocumentFile, REQUIRED]
     tracking_number: str = None
+    shipment_date: str = None
     reference: str = None
     options: Dict = {}