karrio-easyship 2025.5rc1__py3-none-any.whl

karrio/schemas/easyship/manifest_request.py

@@ -0,0 +1,9 @@
+import attr
+import jstruct
+import typing
+
+
+@attr.s(auto_attribs=True)
+class ManifestRequestType:
+    courier_account_id: typing.Optional[str] = None
+    shipment_ids: typing.Optional[typing.List[str]] = None

karrio/schemas/easyship/manifest_response.py

@@ -0,0 +1,31 @@
+import attr
+import jstruct
+import typing
+
+
+@attr.s(auto_attribs=True)
+class DocumentType:
+    format: typing.Optional[str] = None
+    url: typing.Optional[str] = None
+
+
+@attr.s(auto_attribs=True)
+class ManifestType:
+    courier_account_id: typing.Optional[str] = None
+    courier_umbrella_name: typing.Optional[str] = None
+    created_at: typing.Optional[str] = None
+    document: typing.Optional[DocumentType] = jstruct.JStruct[DocumentType]
+    id: typing.Optional[str] = None
+    ref_number: typing.Optional[str] = None
+    shipments_count: typing.Optional[int] = None
+
+
+@attr.s(auto_attribs=True)
+class MetaType:
+    request_id: typing.Optional[str] = None
+
+
+@attr.s(auto_attribs=True)
+class ManifestResponseType:
+    manifest: typing.Optional[ManifestType] = jstruct.JStruct[ManifestType]
+    meta: typing.Optional[MetaType] = jstruct.JStruct[MetaType]

karrio/schemas/easyship/pickup_cancel_response.py

@@ -0,0 +1,19 @@
+import attr
+import jstruct
+import typing
+
+
+@attr.s(auto_attribs=True)
+class MetaType:
+    request_id: typing.Optional[str] = None
+
+
+@attr.s(auto_attribs=True)
+class SuccessType:
+    message: typing.Optional[str] = None
+
+
+@attr.s(auto_attribs=True)
+class PickupCancelResponseType:
+    meta: typing.Optional[MetaType] = jstruct.JStruct[MetaType]
+    success: typing.Optional[SuccessType] = jstruct.JStruct[SuccessType]

karrio/schemas/easyship/pickup_request.py

@@ -0,0 +1,13 @@
+import attr
+import jstruct
+import typing
+
+
+@attr.s(auto_attribs=True)
+class PickupRequestType:
+    courier_id: typing.Optional[str] = None
+    easyship_shipment_ids: typing.Optional[typing.List[str]] = None
+    selected_date: typing.Optional[str] = None
+    selected_from_time: typing.Optional[str] = None
+    selected_to_time: typing.Optional[str] = None
+    time_slot_id: typing.Optional[str] = None

karrio/schemas/easyship/pickup_response.py

@@ -0,0 +1,85 @@
+import attr
+import jstruct
+import typing
+
+
+@attr.s(auto_attribs=True)
+class MetaType:
+    available_balance: typing.Optional[int] = None
+    easyship_shipment_ids: typing.Optional[typing.List[str]] = None
+    request_id: typing.Optional[str] = None
+
+
+@attr.s(auto_attribs=True)
+class DefaultForType:
+    billing: typing.Optional[bool] = None
+    pickup: typing.Optional[bool] = None
+    default_for_return: typing.Optional[bool] = None
+    sender: typing.Optional[bool] = None
+
+
+@attr.s(auto_attribs=True)
+class HkDistrictType:
+    area: typing.Optional[str] = None
+    district: typing.Optional[str] = None
+    id: typing.Optional[int] = None
+    zone: typing.Optional[str] = None
+
+
+@attr.s(auto_attribs=True)
+class ComparisonType:
+    changes: typing.Optional[str] = None
+    post: typing.Optional[str] = None
+    pre: typing.Optional[str] = None
+
+
+@attr.s(auto_attribs=True)
+class ValidationType:
+    detail: typing.Optional[str] = None
+    status: typing.Optional[str] = None
+    comparison: typing.Optional[ComparisonType] = jstruct.JStruct[ComparisonType]
+
+
+@attr.s(auto_attribs=True)
+class AddressType:
+    city: typing.Optional[str] = None
+    company_name: typing.Optional[str] = None
+    contact_email: typing.Optional[str] = None
+    contact_name: typing.Optional[str] = None
+    contact_phone: typing.Optional[str] = None
+    country_alpha2: typing.Optional[str] = None
+    default_for: typing.Optional[DefaultForType] = jstruct.JStruct[DefaultForType]
+    hk_district: typing.Optional[HkDistrictType] = jstruct.JStruct[HkDistrictType]
+    id: typing.Optional[str] = None
+    line_1: typing.Optional[str] = None
+    line_2: typing.Optional[str] = None
+    postal_code: typing.Optional[str] = None
+    state: typing.Optional[str] = None
+    validation: typing.Optional[ValidationType] = jstruct.JStruct[ValidationType]
+
+
+@attr.s(auto_attribs=True)
+class CourierType:
+    id: typing.Optional[str] = None
+    name: typing.Optional[str] = None
+
+
+@attr.s(auto_attribs=True)
+class PickupType:
+    address: typing.Optional[AddressType] = jstruct.JStruct[AddressType]
+    courier: typing.Optional[CourierType] = jstruct.JStruct[CourierType]
+    easyship_pickup_id: typing.Optional[str] = None
+    pickup_fee: typing.Optional[int] = None
+    pickup_reference_number: typing.Optional[str] = None
+    pickup_state: typing.Optional[str] = None
+    provider_name: typing.Optional[str] = None
+    selected_from_time: typing.Optional[str] = None
+    selected_to_time: typing.Optional[str] = None
+    shipments_count: typing.Optional[int] = None
+    total_actual_weight: typing.Optional[float] = None
+
+
+@attr.s(auto_attribs=True)
+class PickupResponseType:
+    meta: typing.Optional[MetaType] = jstruct.JStruct[MetaType]
+    pickup: typing.Optional[PickupType] = jstruct.JStruct[PickupType]

karrio/schemas/easyship/rate_request.py

@@ -0,0 +1,100 @@
+import attr
+import jstruct
+import typing
+
+
+@attr.s(auto_attribs=True)
+class CourierSelectionType:
+    apply_shipping_rules: typing.Optional[bool] = None
+    show_courier_logo_url: typing.Optional[bool] = None
+
+
+@attr.s(auto_attribs=True)
+class ComparisonType:
+    changes: typing.Optional[str] = None
+    post: typing.Optional[str] = None
+    pre: typing.Optional[str] = None
+
+
+@attr.s(auto_attribs=True)
+class ValidationType:
+    detail: typing.Optional[str] = None
+    status: typing.Optional[str] = None
+    comparison: typing.Optional[ComparisonType] = jstruct.JStruct[ComparisonType]
+
+
+@attr.s(auto_attribs=True)
+class NAddressType:
+    country_alpha2: typing.Optional[str] = None
+    city: typing.Optional[str] = None
+    company_name: typing.Optional[str] = None
+    contact_email: typing.Optional[str] = None
+    contact_name: typing.Optional[str] = None
+    contact_phone: typing.Optional[str] = None
+    line_1: typing.Optional[str] = None
+    line_2: typing.Optional[str] = None
+    postal_code: typing.Optional[str] = None
+    state: typing.Optional[str] = None
+    validation: typing.Optional[ValidationType] = jstruct.JStruct[ValidationType]
+
+
+@attr.s(auto_attribs=True)
+class InsuranceType:
+    insured_amount: typing.Optional[float] = None
+    insured_currency: typing.Optional[str] = None
+    is_insured: typing.Optional[bool] = None
+
+
+@attr.s(auto_attribs=True)
+class BoxType:
+    height: typing.Optional[int] = None
+    length: typing.Optional[int] = None
+    width: typing.Optional[int] = None
+    slug: typing.Optional[str] = None
+
+
+@attr.s(auto_attribs=True)
+class ItemType:
+    contains_battery_pi966: typing.Optional[bool] = None
+    contains_battery_pi967: typing.Optional[bool] = None
+    contains_liquids: typing.Optional[bool] = None
+    declared_currency: typing.Optional[str] = None
+    dimensions: typing.Optional[BoxType] = jstruct.JStruct[BoxType]
+    origin_country_alpha2: typing.Optional[str] = None
+    quantity: typing.Optional[int] = None
+    actual_weight: typing.Optional[int] = None
+    category: typing.Optional[str] = None
+    declared_customs_value: typing.Optional[int] = None
+    description: typing.Optional[str] = None
+    sku: typing.Optional[str] = None
+    hs_code: typing.Optional[str] = None
+
+
+@attr.s(auto_attribs=True)
+class ParcelType:
+    box: typing.Optional[BoxType] = jstruct.JStruct[BoxType]
+    items: typing.Optional[typing.List[ItemType]] = jstruct.JList[ItemType]
+    total_actual_weight: typing.Optional[int] = None
+
+
+@attr.s(auto_attribs=True)
+class UnitsType:
+    dimensions: typing.Optional[str] = None
+    weight: typing.Optional[str] = None
+
+
+@attr.s(auto_attribs=True)
+class ShippingSettingsType:
+    output_currency: typing.Optional[str] = None
+    units: typing.Optional[UnitsType] = jstruct.JStruct[UnitsType]
+
+
+@attr.s(auto_attribs=True)
+class RateRequestType:
+    courier_selection: typing.Optional[CourierSelectionType] = jstruct.JStruct[CourierSelectionType]
+    destination_address: typing.Optional[NAddressType] = jstruct.JStruct[NAddressType]
+    incoterms: typing.Optional[str] = None
+    insurance: typing.Optional[InsuranceType] = jstruct.JStruct[InsuranceType]
+    origin_address: typing.Optional[NAddressType] = jstruct.JStruct[NAddressType]
+    parcels: typing.Optional[typing.List[ParcelType]] = jstruct.JList[ParcelType]
+    shipping_settings: typing.Optional[ShippingSettingsType] = jstruct.JStruct[ShippingSettingsType]

karrio/schemas/easyship/rate_response.py

@@ -0,0 +1,124 @@
+import attr
+import jstruct
+import typing
+
+
+@attr.s(auto_attribs=True)
+class PaginationType:
+    count: typing.Optional[int] = None
+    next: typing.Optional[str] = None
+    page: typing.Optional[int] = None
+
+
+@attr.s(auto_attribs=True)
+class MetaType:
+    pagination: typing.Optional[PaginationType] = jstruct.JStruct[PaginationType]
+    request_id: typing.Optional[str] = None
+
+
+@attr.s(auto_attribs=True)
+class DiscountType:
+    amount: typing.Optional[int] = None
+    origin_amount: typing.Optional[int] = None
+
+
+@attr.s(auto_attribs=True)
+class DetailType:
+    fee: typing.Optional[int] = None
+    name: typing.Optional[str] = None
+    origin_fee: typing.Optional[int] = None
+
+
+@attr.s(auto_attribs=True)
+class OtherSurchargesType:
+    details: typing.Optional[typing.List[DetailType]] = jstruct.JList[DetailType]
+    total_fee: typing.Optional[int] = None
+
+
+@attr.s(auto_attribs=True)
+class RatesInOriginCurrencyType:
+    additional_services_surcharge: typing.Optional[int] = None
+    currency: typing.Optional[str] = None
+    ddp_handling_fee: typing.Optional[int] = None
+    estimated_import_duty: typing.Optional[int] = None
+    estimated_import_tax: typing.Optional[float] = None
+    fuel_surcharge: typing.Optional[int] = None
+    import_duty_charge: typing.Optional[int] = None
+    import_tax_charge: typing.Optional[int] = None
+    import_tax_non_chargeable: typing.Optional[int] = None
+    insurance_fee: typing.Optional[int] = None
+    minimum_pickup_fee: typing.Optional[int] = None
+    oversized_surcharge: typing.Optional[int] = None
+    provincial_sales_tax: typing.Optional[int] = None
+    remote_area_surcharge: typing.Optional[int] = None
+    residential_discounted_fee: typing.Optional[int] = None
+    residential_full_fee: typing.Optional[int] = None
+    sales_tax: typing.Optional[int] = None
+    shipment_charge: typing.Optional[int] = None
+    shipment_charge_total: typing.Optional[int] = None
+    total_charge: typing.Optional[int] = None
+    warehouse_handling_fee: typing.Optional[int] = None
+
+
+@attr.s(auto_attribs=True)
+class DestinationType:
+    base: typing.Optional[int] = None
+    name: typing.Optional[str] = None
+
+
+@attr.s(auto_attribs=True)
+class RemoteAreaSurchargesType:
+    destination: typing.Optional[DestinationType] = jstruct.JStruct[DestinationType]
+    origin: typing.Optional[DestinationType] = jstruct.JStruct[DestinationType]
+
+
+@attr.s(auto_attribs=True)
+class RateType:
+    additional_services_surcharge: typing.Optional[int] = None
+    available_handover_options: typing.Optional[typing.List[typing.Any]] = None
+    cost_rank: typing.Optional[int] = None
+    courier_id: typing.Optional[str] = None
+    courier_logo_url: typing.Optional[str] = None
+    courier_name: typing.Optional[str] = None
+    courier_remarks: typing.Optional[str] = None
+    currency: typing.Optional[str] = None
+    ddp_handling_fee: typing.Optional[int] = None
+    delivery_time_rank: typing.Optional[int] = None
+    description: typing.Optional[str] = None
+    discount: typing.Optional[DiscountType] = jstruct.JStruct[DiscountType]
+    easyship_rating: typing.Optional[int] = None
+    estimated_import_duty: typing.Optional[int] = None
+    estimated_import_tax: typing.Optional[float] = None
+    fuel_surcharge: typing.Optional[int] = None
+    full_description: typing.Optional[str] = None
+    import_duty_charge: typing.Optional[int] = None
+    import_tax_charge: typing.Optional[int] = None
+    import_tax_non_chargeable: typing.Optional[int] = None
+    incoterms: typing.Optional[str] = None
+    insurance_fee: typing.Optional[int] = None
+    is_above_threshold: typing.Optional[bool] = None
+    max_delivery_time: typing.Optional[int] = None
+    min_delivery_time: typing.Optional[int] = None
+    minimum_pickup_fee: typing.Optional[int] = None
+    other_surcharges: typing.Optional[OtherSurchargesType] = jstruct.JStruct[OtherSurchargesType]
+    oversized_surcharge: typing.Optional[int] = None
+    payment_recipient: typing.Optional[str] = None
+    provincial_sales_tax: typing.Optional[int] = None
+    rates_in_origin_currency: typing.Optional[RatesInOriginCurrencyType] = jstruct.JStruct[RatesInOriginCurrencyType]
+    remote_area_surcharge: typing.Optional[int] = None
+    remote_area_surcharges: typing.Optional[RemoteAreaSurchargesType] = jstruct.JStruct[RemoteAreaSurchargesType]
+    residential_discounted_fee: typing.Optional[int] = None
+    residential_full_fee: typing.Optional[int] = None
+    sales_tax: typing.Optional[int] = None
+    shipment_charge: typing.Optional[int] = None
+    shipment_charge_total: typing.Optional[int] = None
+    total_charge: typing.Optional[int] = None
+    tracking_rating: typing.Optional[int] = None
+    value_for_money_rank: typing.Optional[int] = None
+    warehouse_handling_fee: typing.Optional[int] = None
+
+
+@attr.s(auto_attribs=True)
+class RateResponseType:
+    meta: typing.Optional[MetaType] = jstruct.JStruct[MetaType]
+    rates: typing.Optional[typing.List[RateType]] = jstruct.JList[RateType]

karrio/schemas/easyship/shipment_cancel_response.py

@@ -0,0 +1,19 @@
+import attr
+import jstruct
+import typing
+
+
+@attr.s(auto_attribs=True)
+class MetaType:
+    request_id: typing.Optional[str] = None
+
+
+@attr.s(auto_attribs=True)
+class SuccessType:
+    message: typing.Optional[str] = None
+
+
+@attr.s(auto_attribs=True)
+class ShipmentCancelResponseType:
+    meta: typing.Optional[MetaType] = jstruct.JStruct[MetaType]
+    success: typing.Optional[SuccessType] = jstruct.JStruct[SuccessType]

karrio/schemas/easyship/shipment_request.py

@@ -0,0 +1,147 @@
+import attr
+import jstruct
+import typing
+
+
+@attr.s(auto_attribs=True)
+class BuyerRegulatoryIdentifiersType:
+    ein: typing.Optional[str] = None
+    vat_number: typing.Optional[str] = None
+
+
+@attr.s(auto_attribs=True)
+class CourierSelectionType:
+    allow_courier_fallback: typing.Optional[bool] = None
+    apply_shipping_rules: typing.Optional[bool] = None
+    list_unavailable_couriers: typing.Optional[bool] = None
+    selected_courier_id: typing.Optional[str] = None
+
+
+@attr.s(auto_attribs=True)
+class AddressType:
+    city: typing.Optional[str] = None
+    company_name: typing.Optional[str] = None
+    contact_email: typing.Optional[str] = None
+    contact_name: typing.Optional[str] = None
+    contact_phone: typing.Optional[str] = None
+    country_alpha2: typing.Optional[str] = None
+    line_1: typing.Optional[str] = None
+    line_2: typing.Optional[str] = None
+    postal_code: typing.Optional[str] = None
+    state: typing.Optional[str] = None
+
+
+@attr.s(auto_attribs=True)
+class InsuranceType:
+    is_insured: typing.Optional[bool] = None
+
+
+@attr.s(auto_attribs=True)
+class OrderDataType:
+    buyer_notes: typing.Optional[str] = None
+    buyer_selected_courier_name: typing.Optional[str] = None
+    order_created_at: typing.Optional[str] = None
+    platform_name: typing.Optional[str] = None
+    platform_order_number: typing.Optional[str] = None
+    order_tag_list: typing.Optional[typing.List[str]] = None
+    seller_notes: typing.Optional[str] = None
+
+
+@attr.s(auto_attribs=True)
+class BoxType:
+    height: typing.Optional[int] = None
+    length: typing.Optional[int] = None
+    width: typing.Optional[int] = None
+    slug: typing.Optional[str] = None
+
+
+@attr.s(auto_attribs=True)
+class ItemType:
+    actual_weight: typing.Optional[int] = None
+    category: typing.Any = None
+    contains_battery_pi966: typing.Optional[bool] = None
+    contains_battery_pi967: typing.Optional[bool] = None
+    contains_liquids: typing.Optional[bool] = None
+    declared_currency: typing.Optional[str] = None
+    declared_customs_value: typing.Optional[int] = None
+    description: typing.Optional[str] = None
+    dimensions: typing.Optional[BoxType] = jstruct.JStruct[BoxType]
+    hs_code: typing.Optional[int] = None
+    origin_country_alpha2: typing.Optional[str] = None
+    quantity: typing.Optional[int] = None
+    sku: typing.Optional[str] = None
+
+
+@attr.s(auto_attribs=True)
+class ParcelType:
+    box: typing.Optional[BoxType] = jstruct.JStruct[BoxType]
+    items: typing.Optional[typing.List[ItemType]] = jstruct.JList[ItemType]
+    total_actual_weight: typing.Optional[int] = None
+
+
+@attr.s(auto_attribs=True)
+class RegulatoryIdentifiersType:
+    eori: typing.Optional[str] = None
+    ioss: typing.Optional[str] = None
+    vat_number: typing.Optional[str] = None
+
+
+@attr.s(auto_attribs=True)
+class AdditionalServicesType:
+    delivery_confirmation: typing.Optional[str] = None
+    qr_code: typing.Optional[str] = None
+
+
+@attr.s(auto_attribs=True)
+class B13AFilingType:
+    option: typing.Optional[str] = None
+    option_export_compliance_statement: typing.Optional[str] = None
+    permit_number: typing.Optional[str] = None
+
+
+@attr.s(auto_attribs=True)
+class PrintingOptionsType:
+    commercial_invoice: typing.Optional[str] = None
+    format: typing.Optional[str] = None
+    label: typing.Optional[str] = None
+    packing_slip: typing.Optional[str] = None
+    remarks: typing.Optional[str] = None
+
+
+@attr.s(auto_attribs=True)
+class UnitsType:
+    dimensions: typing.Optional[str] = None
+    weight: typing.Optional[str] = None
+
+
+@attr.s(auto_attribs=True)
+class ShippingSettingsType:
+    additional_services: typing.Optional[AdditionalServicesType] = jstruct.JStruct[AdditionalServicesType]
+    b13_a_filing: typing.Optional[B13AFilingType] = jstruct.JStruct[B13AFilingType]
+    buy_label: typing.Optional[bool] = None
+    buy_label_synchronous: typing.Optional[bool] = None
+    printing_options: typing.Optional[PrintingOptionsType] = jstruct.JStruct[PrintingOptionsType]
+    units: typing.Optional[UnitsType] = jstruct.JStruct[UnitsType]
+
+
+@attr.s(auto_attribs=True)
+class ShipmentRequestType:
+    buyer_regulatory_identifiers: typing.Optional[BuyerRegulatoryIdentifiersType] = jstruct.JStruct[BuyerRegulatoryIdentifiersType]
+    courier_selection: typing.Optional[CourierSelectionType] = jstruct.JStruct[CourierSelectionType]
+    destination_address: typing.Optional[AddressType] = jstruct.JStruct[AddressType]
+    consignee_tax_id: typing.Optional[int] = None
+    eei_reference: typing.Optional[int] = None
+    incoterms: typing.Optional[str] = None
+    metadata: typing.Optional[typing.List[typing.Any]] = None
+    insurance: typing.Optional[InsuranceType] = jstruct.JStruct[InsuranceType]
+    order_data: typing.Optional[OrderDataType] = jstruct.JStruct[OrderDataType]
+    origin_address: typing.Optional[AddressType] = jstruct.JStruct[AddressType]
+    regulatory_identifiers: typing.Optional[RegulatoryIdentifiersType] = jstruct.JStruct[RegulatoryIdentifiersType]
+    shipment_request_return: typing.Optional[bool] = None
+    return_address: typing.Optional[AddressType] = jstruct.JStruct[AddressType]
+    return_address_id: typing.Optional[str] = None
+    sender_address: typing.Optional[AddressType] = jstruct.JStruct[AddressType]
+    sender_address_id: typing.Optional[str] = None
+    set_as_residential: typing.Optional[bool] = None
+    shipping_settings: typing.Optional[ShippingSettingsType] = jstruct.JStruct[ShippingSettingsType]
+    parcels: typing.Optional[typing.List[ParcelType]] = jstruct.JList[ParcelType]