api.md

Keys

Types:

from partnermax.types import KeyListResponse, KeyIssueResponse

Methods:

• client.keys.list() -> KeyListResponse
• client.keys.issue(**params) -> KeyIssueResponse
• client.keys.revoke(key_id) -> None

Dealers

Types:

from partnermax.types import DealerDetail, DealerSummary, PartnerDealerResponse

Methods:

• client.dealers.create(**params) -> PartnerDealerResponse
• client.dealers.retrieve(dealer_id) -> DealerDetail
• client.dealers.update(dealer_id, **params) -> DealerDetail
• client.dealers.list(**params) -> SyncCursorPage[DealerSummary]
• client.dealers.delete(dealer_id) -> None
• client.dealers.activate_reference(external_dealer_id) -> PartnerDealerResponse
• client.dealers.revoke_reference(external_dealer_id) -> None
• client.dealers.suspend_reference(external_dealer_id) -> PartnerDealerResponse

NltSettings

Types:

from partnermax.types.dealers import DownPaymentTiers, NltSettings

Methods:

• client.dealers.nlt_settings.retrieve(dealer_id) -> NltSettings
• client.dealers.nlt_settings.update(dealer_id, **params) -> NltSettings

Nlt

Offers

Types:

from partnermax.types.dealers.nlt import NltOfferSummary, OfferRetrieveResponse

Methods:

• client.dealers.nlt.offers.retrieve(offer_id, *, dealer_id) -> OfferRetrieveResponse
• client.dealers.nlt.offers.list(dealer_id, **params) -> SyncCursorPage[NltOfferSummary]

Vehicles

Types:

from partnermax.types.dealers import (
    AIContent,
    BulkCreateVehiclesResponse,
    BulkRowOutcome,
    VehicleDetail,
    VehicleList,
    VehicleSummary,
)

Methods:

• client.dealers.vehicles.create(dealer_id, **params) -> VehicleDetail
• client.dealers.vehicles.retrieve(vehicle_id, *, dealer_id, **params) -> VehicleDetail
• client.dealers.vehicles.update(vehicle_id, *, dealer_id, **params) -> VehicleDetail
• client.dealers.vehicles.list(dealer_id, **params) -> SyncCursorPage[VehicleSummary]
• client.dealers.vehicles.delete(vehicle_id, *, dealer_id) -> None
• client.dealers.vehicles.bulk(dealer_id, **params) -> BulkCreateVehiclesResponse

Images

Types:

from partnermax.types.dealers.vehicles import VehicleImage, VehicleImageList

Methods:

• client.dealers.vehicles.images.create(vehicle_id, *, dealer_id, **params) -> VehicleImage
• client.dealers.vehicles.images.list(vehicle_id, *, dealer_id) -> VehicleImageList
• client.dealers.vehicles.images.delete(image_id, *, dealer_id, vehicle_id) -> None

Accessories

Types:

from partnermax.types.dealers.vehicles import VehicleAccessoriesCatalog, VehicleAccessoryItem

Methods:

• client.dealers.vehicles.accessories.update(vehicle_id, *, dealer_id, **params) -> VehicleAccessoriesCatalog
• client.dealers.vehicles.accessories.refresh_catalog(vehicle_id, *, dealer_id) -> VehicleAccessoriesCatalog
• client.dealers.vehicles.accessories.retrieve_catalog(vehicle_id, *, dealer_id) -> VehicleAccessoriesCatalog