bb-integrations-library 3.0.11__py3-none-any.whl

bb_integrations_lib/models/sd/bols_and_drops.py

@@ -0,0 +1,241 @@
+from datetime import datetime
+from typing import Optional
+
+from pydantic import BaseModel
+
+
+class DriverExtraData(BaseModel):
+    source_id: Optional[str] = None
+    source_system_id: Optional[str] = None
+
+
+class Drop(BaseModel):
+    compartment_indexes: list[int]
+    before_stick_inches: Optional[int] = None
+    before_stick_time: Optional[datetime] = None
+    after_stick_inches: Optional[int] = None
+    after_stick_time: Optional[datetime] = None
+    drop_id: str
+    location: str
+    location_id: str
+    location_source_id: Optional[str] = None
+    location_source_system: Optional[str] = None
+    product: str
+    product_id: str
+    product_source_id: Optional[str] = None
+    product_source_system: Optional[str] = None
+    tank_id: Optional[int] = None
+    tank_source_id: Optional[str] = None
+    tank_source_system: Optional[str] = None
+    volume: int
+    driver_id: Optional[str] = None
+    driver_username: Optional[str] = None
+    driver_extra_data: Optional[DriverExtraData] = None
+    driver_name: Optional[str] = None
+    driver_date: Optional[datetime] = None
+    driver_shift: Optional[str] = None
+    driver_shift_id: Optional[str] = None
+    tractor_number: Optional[str] = None
+    trailer_number: Optional[str] = None
+    blend_codes: list[str] = []
+    site_counterparty_id: Optional[str] = None
+    site_counterparty_name: Optional[str] = None
+    freight_customer_id: Optional[str] = None
+    freight_customer_name: Optional[str] = None
+
+
+class BOLPriceDetails(BaseModel):
+    price: Optional[float] = None
+    price_id: Optional[str] = None
+    curve_id: Optional[str] = None
+    date: Optional[datetime] = None
+    counterparty_id: Optional[str] = None
+
+
+class BOLDetail(BaseModel):
+    compartment_index: Optional[int] = None
+    load_number: Optional[str] = None
+    product: str
+    product_id: str
+    product_source_id: Optional[str] = None
+    product_source_system: Optional[str] = None
+    net_volume: int
+    gross_volume: int
+    supplier: Optional[str] = None
+    supplier_id: Optional[str] = None
+    supplier_source_id: Optional[str] = None
+    supplier_source_system: Optional[str] = None
+    contract: Optional[str] = None
+    price_details: Optional[BOLPriceDetails] = None
+
+
+class BOL(BaseModel):
+    bol_number: str
+    bol_id: str
+    date: Optional[datetime] = None
+    details: list[BOLDetail] = []
+    load_or_drop: Optional[str] = None
+    location: Optional[str] = None
+    location_id: Optional[str] = None
+    location_source_id: Optional[str] = None
+    location_source_system: Optional[str] = None
+    driver_id: Optional[str] = None
+    driver_username: Optional[str] = None
+    driver_extra_data: Optional[DriverExtraData] = None
+    driver_name: Optional[str] = None
+    driver_date: Optional[datetime] = None
+    driver_shift: Optional[str] = None
+    driver_shift_id: Optional[str] = None
+    tractor_number: Optional[str] = None
+    trailer_number: Optional[str] = None
+
+
+class Cost(BaseModel):
+    cost_type: str
+    carrier: Optional[str] = None
+    carrier_source_id: Optional[str] = None
+    carrier_source_system: Optional[str] = None
+    per_unit_price: Optional[float] = None
+    cost_amount: Optional[float] = None
+
+
+class FreightLeg(BaseModel):
+    origin: str
+    origin_id: str
+    destination: str
+    destination_id: str
+    distance: Optional[float] = None
+
+
+class FreightTransaction(BaseModel):
+    model_type: Optional[str] = None
+    type: Optional[str] = None
+    subtype: Optional[str] = None
+    rate: Optional[float] = None
+    amount: Optional[float] = None
+    total: Optional[float] = None
+    uom: Optional[str] = None
+    errors: list[str] = []
+    id: str
+    product_group: Optional[str] = None
+    product_id: Optional[str] = None
+    product_name: Optional[str] = None
+    origin: Optional[str] = None
+    origin_id: Optional[str] = None
+    origin_override: Optional[str] = None
+    origin_id_override: Optional[str] = None
+    destination: Optional[str] = None
+    destination_id: Optional[str] = None
+    destination_override: Optional[str] = None
+    destination_id_override: Optional[str] = None
+    legs: list[FreightLeg] = []
+    use_surcharge: Optional[bool] = None
+    manual: Optional[bool] = None
+    has_dependency: Optional[bool] = None
+    created_date: Optional[datetime] = None
+    requires_approval: Optional[bool] = None
+    requires_approval_reason_code: Optional[bool] = None
+    is_approved: Optional[bool] = None
+    approved_by: Optional[str] = None
+    approved_date: Optional[datetime] = None
+    approved_reason_code: Optional[str] = None
+    amount_override: Optional[float] = None
+    rate_override: Optional[float] = None
+    product_id_override: Optional[str] = None
+    product_name_override: Optional[str] = None
+    product_group_override: Optional[str] = None
+    subtype_override: Optional[str] = None
+    uom_override: Optional[str] = None
+    total_override: Optional[float] = None
+    override_by: Optional[str] = None
+    override_date: Optional[datetime] = None
+    exclude_from_invoice: Optional[bool] = None
+    credit_rebill_metadata: Optional[dict] = None
+    extra_data: Optional[dict] = None
+    gross_volume: Optional[int] = None
+    net_volume: Optional[int] = None
+    bol_date: Optional[datetime] = None
+    bol_number: Optional[str] = None
+    bol_number_override: Optional[str] = None
+    delivery_date: Optional[datetime] = None
+
+
+class Freight(BaseModel):
+    id: str
+    parent: Optional[str] = None
+    created_at: Optional[datetime] = None
+    type: Optional[str] = None
+    status: Optional[str] = None
+    reversed: Optional[bool] = None
+    transactions: list[FreightTransaction] = []
+    counterparty_id: Optional[str] = None
+    book_type: Optional[str] = None
+    effective_date_used: Optional[datetime] = None
+    invoice_group_id: Optional[str] = None
+    invoice_number: Optional[str] = None
+    accessorial_invoice_number: Optional[str] = None
+    new_version_available: Optional[bool] = None
+    new_version_total: Optional[float] = None
+    error: Optional[str] = None
+
+
+class AllocatedBOLPrice(BaseModel):
+    contract: Optional[str] = None
+    price_type: Optional[str] = None
+    price_id: Optional[str] = None
+    curve_id: Optional[str] = None
+    price: Optional[float] = None
+    date: Optional[datetime] = None
+    expired: Optional[bool] = None
+
+
+class AllocatedBOL(BaseModel):
+    bol_number: str
+    bol_id: str
+    bol_terminal_id: Optional[str] = None
+    bol_terminal: Optional[str] = None
+    bol_product: Optional[str] = None
+    bol_product_id: Optional[str] = None
+    bol_supplier: Optional[str] = None
+    bol_supplier_id: Optional[str] = None
+    bol_net_volume_original: Optional[int] = None
+    bol_gross_volume_original: Optional[int] = None
+    store_number: Optional[str] = None
+    store_id: Optional[str] = None
+    location_id: Optional[str] = None
+    store_tank: Optional[int] = None
+    store_product: Optional[str] = None
+    store_product_id: Optional[str] = None
+    store_timezone: Optional[str] = None
+    bol_net_volume_allocated: Optional[int] = None
+    bol_gross_volume_allocated: Optional[int] = None
+    driver_schedule: Optional[str] = None
+    bol_date: Optional[datetime] = None
+    delivered_date: Optional[datetime] = None
+    price: Optional[AllocatedBOLPrice] = None
+
+
+class Order(BaseModel):
+    order_number: str
+    order_id: str
+    po: Optional[str] = None
+    carrier: Optional[str] = None
+    carrier_id: Optional[str] = None
+    manager: Optional[str] = None
+    manager_id: Optional[str] = None
+    last_movement_update: Optional[datetime] = None
+    order_date: Optional[datetime] = None
+    status: Optional[str] = None
+    type: Optional[str] = None
+    drops: list[Drop] = []
+    bols: list[BOL] = []
+    costs: list[Cost] = []
+    validation_bypass_on: Optional[datetime] = None
+    has_additives: Optional[bool] = None
+    estimated_freight: Optional[Freight] = None
+    actual_freight: Optional[Freight] = None
+    allocated_bol_error: Optional[str] = None
+    allocated_bol_issue: Optional[str] = None
+    allocated_bols: list[AllocatedBOL] = []
+    last_change_date: Optional[datetime] = None
+    reference_order_number: Optional[str] = None

bb_integrations_lib/models/sd/get_order.py

@@ -0,0 +1,301 @@
+from datetime import datetime
+from typing import Optional
+
+from pydantic import BaseModel
+
+
+class Driver(BaseModel):
+    driver_id: str
+    driver_schedule_id: Optional[str] = None
+    name: Optional[str] = None
+    username: Optional[str] = None
+
+
+class LoadDetail(BaseModel):
+    detail_id: str
+    counterparty_id: Optional[str] = None
+    counterparty_name: Optional[str] = None
+    counterparty_source_id: Optional[str] = None
+    counterparty_source_system: Optional[str] = None
+    price_type: Optional[str] = None
+    contract: Optional[str] = None
+    product_id: str
+    product_name: Optional[str] = None
+    product_source_id: Optional[str] = None
+    product_source_system: Optional[str] = None
+    drop_product_id: Optional[str] = None
+    drop_product_name: Optional[str] = None
+    drop_product_source_id: Optional[str] = None
+    drop_product_source_system: Optional[str] = None
+    quantity: int
+    compartment_index: Optional[int] = None
+    blend_code: Optional[str] = None
+    product_codes: list[str] = []
+    load_number: Optional[str] = None
+
+
+class Load(BaseModel):
+    location_id: str
+    location_name: Optional[str] = None
+    location_source_id: Optional[str] = None
+    location_source_system: Optional[str] = None
+    location_type: Optional[str] = None
+    details: list[LoadDetail] = []
+    eta: Optional[datetime] = None
+    status: Optional[str] = None
+
+
+class DropSource(BaseModel):
+    compartment_index: int
+    volume: int
+
+
+class DropDetail(BaseModel):
+    detail_id: str
+    counterparty_id: Optional[str] = None
+    counterparty_name: Optional[str] = None
+    counterparty_source_id: Optional[str] = None
+    counterparty_source_system: Optional[str] = None
+    product_id: str
+    product_name: Optional[str] = None
+    product_source_id: Optional[str] = None
+    product_source_system: Optional[str] = None
+    quantity: int
+    tank_id: Optional[int] = None
+    sources: list[DropSource] = []
+    destination_codes: list[str] = []
+    blend_codes: list[str] = []
+
+
+class Drop(BaseModel):
+    location_id: str
+    location_name: Optional[str] = None
+    location_source_id: Optional[str] = None
+    location_source_system: Optional[str] = None
+    location_type: Optional[str] = None
+    details: list[DropDetail] = []
+    eta: Optional[datetime] = None
+    status: Optional[str] = None
+
+
+class Detour(BaseModel):
+    location_id: Optional[str] = None
+    location_name: Optional[str] = None
+    eta: Optional[datetime] = None
+    status: Optional[str] = None
+
+
+class FreightLeg(BaseModel):
+    origin: str
+    origin_id: str
+    destination: str
+    destination_id: str
+    distance: Optional[float] = None
+
+
+class FreightTransaction(BaseModel):
+    model_type: Optional[str] = None
+    type: Optional[str] = None
+    subtype: Optional[str] = None
+    rate: Optional[float] = None
+    amount: Optional[float] = None
+    total: Optional[float] = None
+    uom: Optional[str] = None
+    errors: list[str] = []
+    id: str
+    product_group: Optional[str] = None
+    product_id: Optional[str] = None
+    product_name: Optional[str] = None
+    origin: Optional[str] = None
+    origin_id: Optional[str] = None
+    origin_override: Optional[str] = None
+    origin_id_override: Optional[str] = None
+    destination: Optional[str] = None
+    destination_id: Optional[str] = None
+    destination_override: Optional[str] = None
+    destination_id_override: Optional[str] = None
+    legs: list[FreightLeg] = []
+    use_surcharge: Optional[bool] = None
+    manual: Optional[bool] = None
+    has_dependency: Optional[bool] = None
+    created_date: Optional[datetime] = None
+    requires_approval: Optional[bool] = None
+    requires_approval_reason_code: Optional[bool] = None
+    is_approved: Optional[bool] = None
+    approved_by: Optional[str] = None
+    approved_date: Optional[datetime] = None
+    approved_reason_code: Optional[str] = None
+    amount_override: Optional[float] = None
+    rate_override: Optional[float] = None
+    product_id_override: Optional[str] = None
+    product_name_override: Optional[str] = None
+    product_group_override: Optional[str] = None
+    subtype_override: Optional[str] = None
+    uom_override: Optional[str] = None
+    total_override: Optional[float] = None
+    override_by: Optional[str] = None
+    override_date: Optional[datetime] = None
+    exclude_from_invoice: Optional[bool] = None
+    credit_rebill_metadata: Optional[dict] = None
+    extra_data: Optional[dict] = None
+    gross_volume: Optional[int] = None
+    net_volume: Optional[int] = None
+    bol_date: Optional[datetime] = None
+    bol_number: Optional[str] = None
+    bol_number_override: Optional[str] = None
+    delivery_date: Optional[datetime] = None
+
+
+class EstimatedFreight(BaseModel):
+    id: str
+    parent: Optional[str] = None
+    created_at: Optional[datetime] = None
+    type: Optional[str] = None
+    status: Optional[str] = None
+    reversed: Optional[bool] = None
+    transactions: list[FreightTransaction] = []
+    counterparty_id: Optional[str] = None
+    book_type: Optional[str] = None
+    effective_date_used: Optional[datetime] = None
+    invoice_group_id: Optional[str] = None
+    invoice_number: Optional[str] = None
+    accessorial_invoice_number: Optional[str] = None
+    new_version_available: Optional[bool] = None
+    new_version_total: Optional[float] = None
+    error: Optional[str] = None
+
+
+class PriceComponent(BaseModel):
+    timezone_data: Optional[str] = None
+    curve_id: Optional[str] = None
+    price_id: Optional[str] = None
+    terminal_id: Optional[str] = None
+    terminal: Optional[str] = None
+    supplier_id: Optional[str] = None
+    supplier: Optional[str] = None
+    price_type: Optional[str] = None
+    product_id: Optional[str] = None
+    product: Optional[str] = None
+    supply_owner_id: Optional[str] = None
+    supply_owner: Optional[str] = None
+    price: Optional[float] = None
+    contract: Optional[str] = None
+    volume: Optional[int] = None
+    effective_from: Optional[datetime] = None
+    effective_to: Optional[datetime] = None
+    group_id: Optional[str] = None
+    group_effective_cutover: Optional[datetime] = None
+    group_effective_cutover_timezone: Optional[str] = None
+    group_identifier: Optional[str] = None
+    group_name: Optional[str] = None
+    min_constraint: Optional[float] = None
+    max_constraint: Optional[float] = None
+    load_number: Optional[str] = None
+    load_numbers: list[str] = []
+    directive_info: Optional[dict] = None
+
+
+class Price(BaseModel):
+    product_name: Optional[str] = None
+    volume: Optional[int] = None
+    components: list[PriceComponent] = []
+    product_total: Optional[float] = None
+    blend_code: Optional[str] = None
+
+
+class SupplyOwnerDefinition(BaseModel):
+    location_name: Optional[str] = None
+    product: Optional[str] = None
+    supply_owner_id: Optional[str] = None
+
+
+class SupplyOwnerMap(BaseModel):
+    definitions: list[SupplyOwnerDefinition] = []
+
+
+class SupplyOption(BaseModel):
+    option: Optional[str] = None
+    carrier_id: Optional[str] = None
+    carrier: Optional[str] = None
+    loaded_miles: Optional[float] = None
+    freight: Optional[float] = None
+    freight_cost: Optional[float] = None
+    stops: Optional[int] = None
+    prices: list[Price] = []
+    product_total: Optional[float] = None
+    landed_cost: Optional[float] = None
+    supply_owner_map: Optional[SupplyOwnerMap] = None
+    freight_customer_id: Optional[str] = None
+    delivered: Optional[bool] = None
+    out_of_network: Optional[bool] = None
+    estimated_freight: Optional[EstimatedFreight] = None
+    legs: list[FreightLeg] = []
+    freight_distance: Optional[float] = None
+    supply_owner_id: Optional[str] = None
+
+
+class GetOrderResponse(BaseModel):
+    type: str
+    order_id: Optional[str] = None
+    drivers: list[Driver] = []
+    order_number: Optional[int] = None
+    order_date: Optional[datetime] = None
+    order_state: Optional[str] = None
+    carrier_window_start: Optional[datetime] = None
+    carrier_window_end: Optional[datetime] = None
+    carrier_window_start_local: Optional[datetime] = None
+    carrier_window_end_local: Optional[datetime] = None
+    carrier_notify_state: Optional[str] = None
+    load_window_start: Optional[datetime] = None
+    load_window_end: Optional[datetime] = None
+    dispatch_window_start: Optional[datetime] = None
+    dispatch_window_end: Optional[datetime] = None
+    hauler_counterparty_id: Optional[str] = None
+    hauler_counterparty_name: Optional[str] = None
+    hauler_counterparty_source_id: Optional[str] = None
+    hauler_counterparty_source_system: Optional[str] = None
+    hauled_by_updated_by: Optional[str] = None
+    hauled_by_updated: Optional[datetime] = None
+    loads: list[Load] = []
+    drops: list[Drop] = []
+    detours: list[Detour] = []
+    trip_status: Optional[str] = None
+    last_change_date: Optional[datetime] = None
+    market: Optional[str] = None
+    supply_option: Optional[SupplyOption] = None
+    created_by: Optional[str] = None
+    note: Optional[str] = None
+    estimated_load_minutes: Optional[int] = None
+    total_miles: Optional[float] = None
+    loaded_miles: Optional[float] = None
+    unloaded_miles: Optional[float] = None
+    reference_order_number: Optional[str] = None
+    extra_data: Optional[dict] = None
+    tractor: Optional[str] = None
+    trailer: Optional[str] = None
+    po_number: Optional[str] = None
+
+
+class GetOrderRequestProduct(BaseModel):
+    product_id: Optional[str] = None
+    product_name: Optional[str] = None
+    quantity: Optional[int] = None
+
+
+class GetOrderRequestResponse(BaseModel):
+    type: Optional[str] = None
+    number: int
+    order_id: Optional[str] = None
+    order_number: Optional[int] = None
+    order_date: Optional[datetime] = None
+    order_state: Optional[str] = None
+    reference_order_number: Optional[str] = None
+    last_change_date: Optional[datetime] = None
+    site_name: Optional[str] = None
+    site_id: Optional[str] = None
+    customer_id: Optional[str] = None
+    customer_name: Optional[str] = None
+    delivery_window_start: datetime
+    delivery_window_end: datetime
+    products: list[GetOrderRequestProduct] = []
+    extra_data: Optional[dict] = None

bb_integrations_lib/models/sd/orders.py

@@ -0,0 +1,18 @@
+from datetime import datetime
+from enum import StrEnum
+from typing import List
+
+from pydantic import BaseModel
+
+
+class ERPStatus(StrEnum):
+    """Copied from supply_and_dispatch_aio 2025-06-17"""
+    sent = "sent"
+    unsent = "unsent"
+    errors = "errors"
+
+class BackofficeERP(BaseModel):
+    """Copied from supply_and_dispatch_aio 2025-06-17"""
+    status: ERPStatus = ERPStatus.unsent
+    time_sent: datetime | None = None
+    errors: List = []

bb_integrations_lib/models/sd_api.py

@@ -0,0 +1,115 @@
+from datetime import datetime
+from typing import Literal
+
+from pydantic import BaseModel, Field
+
+
+class HierarchyKey(BaseModel):
+    id: str | None = None
+    name: str | None = None
+    source_system: str | None = None
+    source_id: str | None = None
+
+
+class SiteKey(BaseModel):
+    id: str | None = None
+    number: str | None = None
+    source_system: str | None = None
+    source_id: str | None = None
+
+
+class OrderKey(BaseModel):
+    order_number: int | None
+    order_id: str | None = None
+    order_reference_number: str | None = None
+
+
+class DeliveryWindow(BaseModel):
+    start: datetime
+    end: datetime
+    timezone: str = "UTC"
+
+
+class LoadsCreateRequest(BaseModel):
+    terminal: HierarchyKey | None = None
+    product: HierarchyKey | None = None
+    supplier: HierarchyKey | None = None
+    price_type: str | None = None
+
+
+class DropCreateRequest(BaseModel):
+    site: SiteKey
+    tank_id: str | None = None
+    product: HierarchyKey
+    volume: int
+    loads: list[LoadsCreateRequest] = []
+
+
+class OrderCreateRequest(BaseModel):
+    reference_order_number: str
+    supply_owner: HierarchyKey | None = None
+    sourcing_strategy: Literal["Specific Supply", "Tank Supply Default", "Use Best", "Manual"] = "Specific Supply"
+    manual_supply_fallback: bool = True
+    allow_alternate_products: bool = False
+    delivery_window: DeliveryWindow
+    fit_to_trailer: bool = False
+
+    note: str | None = None
+    drops: list[DropCreateRequest]
+    extra_data: dict
+
+
+class OrderStatusUpdateRequest(BaseModel):
+    order_id: str
+    order_number: str | None = None
+    status: str
+    location_id: str | None = None
+    eta: datetime | None = None
+    actual: datetime | None = None
+
+class DropDetail(BaseModel):
+    product_id: str
+    quantity: float
+    tank_id: int | None = None
+    pre_drop_volume: float | None = None
+    pre_drop_inches: float | None = None
+    pre_drop_time: datetime | None = None
+    post_drop_volume: float | None = None
+    post_drop_inches: float | None = None
+    post_drop_time: datetime | None = None
+
+class SaveDropDetailsRequest(BaseModel):
+    order_id: str
+    location_id: str
+    mode: Literal["replace", "append"]
+    details: list[DropDetail]
+
+class BOLDetail(BaseModel):
+    supplier_id: str
+    product_id: str
+    contract: str | None = None
+    price_type: str | None = None
+    net_volume: float
+    gross_volume: float
+
+class SaveBOLDetailsRequest(BaseModel):
+    order_id: str
+    bol_number: str
+    terminal_id: str
+    bol_date: datetime
+    details: list[BOLDetail]
+
+class OrderUpdateRequest(BaseModel):
+    order: OrderKey = Field(...)
+    sourcing_strategy: Literal["Specific Supply", "Tank Supply Default", "Use Best", "Manual"] = Field(default="Use Best")
+    delivery_window: DeliveryWindow | None = Field(default=None, description="If provided, replaces the existing delivery window.")
+    note: str | None = Field(default=None, description="If provided, replaces the existing note.")
+    drops: list[DropCreateRequest] = Field(default=[], description="If provided, replaces all existing drops.")
+    extra_data: dict = Field(default={}, description="Merge this extra data with the existing extra data. New keys will be added, existing keys will be updated.")
+
+class SendToCarrierRequest(BaseModel):
+    order_ids: list[str]
+    force: bool = False
+    instant: bool = False
+    actual_end_date: datetime | None = None
+    send_email: bool = True