darbiadev_ups.ups_services

UPSServices

Module Contents

Classes

_AuthType	An enum for the authentication types
UPSServices	A class wrapping UPS' API.

class darbiadev_ups.ups_services._AuthType(*args, **kwds)

Bases: enum.Enum

An enum for the authentication types

HEADERS

JSON

class darbiadev_ups.ups_services.UPSServices(base_url: str, username: str, password: str, access_license_number: str)

A class wrapping UPS’ API.

TRACKING_REGEX: Final[str] = '1Z[A-Z0-9]{6}[0-9]{10}'

TRACKING_URL: Final[str] = 'https://wwwapps.ups.com/WebTracking/processInputRequest?TypeOfInquiryNumber=T&InquiryNumber1={tra...'

__auth_headers() → dict[str, str]

Return authentication headers as a dictionary

__auth_dict() → dict[str, dict[str, dict[str, str]]]

Return authentication JSON as a dictionary

make_request(method: str, auth_type: _AuthType, service: str, data: dict[str, Any], timeout: int = 500) → dict

Make a request to UPS’ API

track(tracking_number: str) → dict

Get tracking details for a tracking number

validate_address(street_lines: list[str], city: str, state: str, postal_code: str, country: str)

Validate an address

time_in_transit(from_state: str, from_postal_code: str, from_country: str, to_state: str, to_postal_code: str, to_country: str, weight: str, pickup_date: str = None) → dict[str, str | list[dict[str, str]]]

Estimate transit time