@cardog/ocm-client 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,866 @@
+/**
+ * Request and response types for OCM API endpoints
+ */
+type DistanceUnit = "km" | "miles";
+type OutputFormat = "json" | "xml" | "kml" | "geojson";
+type SortOrder = "distance" | "id" | "relevance";
+/**
+ * Parameters for POI search endpoint (GET /v4/poi)
+ */
+interface POISearchParams {
+    latitude?: number;
+    longitude?: number;
+    distance?: number;
+    distanceunit?: DistanceUnit;
+    boundingbox?: string;
+    polyline?: string;
+    chargepointid?: number | number[];
+    countryid?: number | number[];
+    countrycode?: string;
+    operatorid?: number | number[];
+    connectiontypeid?: number | number[];
+    statustypeid?: number | number[];
+    usagetypeid?: number | number[];
+    levelid?: number | number[];
+    dataproviderid?: number | number[];
+    submissionstatustypeid?: number | number[];
+    minpowerkw?: number;
+    maxresults?: number;
+    modifiedsince?: string | Date;
+    output?: OutputFormat;
+    compact?: boolean;
+    verbose?: boolean;
+    camelcase?: boolean;
+    includecomments?: boolean;
+    client?: string;
+}
+/**
+ * Parameters for authentication endpoint
+ */
+interface AuthenticateParams {
+    EmailAddress: string;
+    Password: string;
+}
+/**
+ * Response from authentication endpoint
+ */
+interface AuthenticateResponse {
+    ID: number;
+    CurrentSessionToken: string;
+    APIKey?: string;
+    Username?: string;
+    EmailAddress?: string;
+    Profile?: {
+        ID: number;
+        Username?: string;
+        ProfileImageURL?: string;
+        ReputationPoints?: number;
+    };
+}
+/**
+ * Parameters for submitting a new POI
+ */
+interface SubmitPOIParams {
+    AddressInfo: {
+        Title?: string;
+        AddressLine1?: string;
+        Town?: string;
+        StateOrProvince?: string;
+        Postcode?: string;
+        CountryID: number;
+        Latitude: number;
+        Longitude: number;
+        ContactTelephone1?: string;
+        ContactEmail?: string;
+        AccessComments?: string;
+        RelatedURL?: string;
+    };
+    Connections?: Array<{
+        ConnectionTypeID: number;
+        StatusTypeID?: number;
+        LevelID?: number;
+        Amps?: number;
+        Voltage?: number;
+        PowerKW?: number;
+        CurrentTypeID?: number;
+        Quantity?: number;
+        Comments?: string;
+    }>;
+    NumberOfPoints?: number;
+    OperatorID?: number;
+    UsageTypeID?: number;
+    StatusTypeID?: number;
+    GeneralComments?: string;
+    UsageCost?: string;
+    DataProvidersReference?: string;
+}
+/**
+ * Parameters for submitting a comment
+ */
+interface SubmitCommentParams {
+    ChargePointID: number;
+    CommentTypeID?: number;
+    Comment?: string;
+    Rating?: number;
+    CheckinStatusTypeID?: number;
+    UserName?: string;
+}
+/**
+ * API error response
+ */
+interface APIError {
+    status: number;
+    message: string;
+    code?: string;
+}
+/**
+ * GeoJSON Feature representation of a POI
+ */
+interface POIGeoJSONFeature {
+    type: "Feature";
+    geometry: {
+        type: "Point";
+        coordinates: [number, number];
+    };
+    properties: {
+        ID: number;
+        Name?: string;
+        AddressLine1?: string;
+        Town?: string;
+        StateOrProvince?: string;
+        Postcode?: string;
+        Country?: string;
+        Operator?: string;
+        UsageCost?: string;
+        NumberOfPoints?: number;
+        StatusType?: string;
+        UsageType?: string;
+        Connections?: string;
+        [key: string]: unknown;
+    };
+}
+interface POIGeoJSONCollection {
+    type: "FeatureCollection";
+    features: POIGeoJSONFeature[];
+}
+
+/**
+ * Standard connection type IDs from Open Charge Map
+ *
+ * These values correspond to the ConnectionType reference data.
+ * @see https://github.com/openchargemap/ocm-system/blob/master/API/OCM.Net/OCM.API.Model/Base/CoreReferenceData.cs#L89
+ * @see https://openchargemap.org/site/develop/api - GET /v4/referencedata
+ */
+declare enum StandardConnectionTypes {
+    /** Unknown or unspecified connector */
+    Unknown = 0,
+    /** SAE J1772 - Standard North American Level 1/2 connector */
+    J1772 = 1,
+    /** CHAdeMO - Japanese DC fast charging standard */
+    CHAdeMO = 2,
+    /** IEC 62196-2 Type 2 - European AC connector (Mennekes) */
+    Type2Mennekes = 25,
+    /** Type 2 socket outlet */
+    Type2Outlet = 28,
+    /** SAE J1772 Combo (CCS1) - North American DC fast charging */
+    CCSCombo1 = 32,
+    /** IEC 62196-3 Combo (CCS2) - European DC fast charging */
+    CCSCombo2 = 33,
+    /** Tesla proprietary connector (Roadster) */
+    Tesla = 27,
+    /** Tesla Supercharger connector */
+    TeslaSupercharger = 30,
+    /** NACS (North American Charging Standard) - Tesla's connector adopted as SAE J3400 */
+    NACS = 36,
+    /** Alias for CCSCombo1 */
+    Type1CCS = 32,
+    /** Alias for CCSCombo2 */
+    Type2CCS = 33
+}
+/**
+ * Standard status type IDs indicating operational state
+ *
+ * @see https://github.com/openchargemap/ocm-system/blob/master/API/OCM.Net/OCM.API.Model/Base/CoreReferenceData.cs#L71
+ */
+declare enum StandardStatusTypes {
+    /** Status unknown or not specified */
+    Unknown = 0,
+    /** Station is operational and available for use */
+    CurrentlyAvailable = 50,
+    /** Alias for CurrentlyAvailable */
+    Operational = 50,
+    /** Station is not operational */
+    NotOperational = 100,
+    /** Station is planned for future installation */
+    PlannedForFuture = 150,
+    /** Station is temporarily unavailable (maintenance, etc.) */
+    TemporarilyUnavailable = 75,
+    /** Station has been removed/decommissioned */
+    Removed = 200
+}
+/**
+ * Standard usage type IDs indicating access restrictions
+ *
+ * @see https://github.com/openchargemap/ocm-system/blob/master/API/OCM.Net/OCM.API.Model/Base/CoreReferenceData.cs#L80
+ */
+declare enum StandardUsageTypes {
+    /** Usage type unknown */
+    Unknown = 0,
+    /** Public access - no restrictions */
+    Public = 1,
+    /** Public access but membership/account required */
+    PublicMembershipRequired = 4,
+    /** Public access with payment at location */
+    PublicPayAtLocation = 5,
+    /** Public access but notice/call ahead required */
+    PublicNoticeRequired = 7,
+    /** Private - restricted access */
+    Private = 2,
+    /** Private - for staff and visitors only */
+    PrivateForStaffAndVisitors = 6,
+    /** Private residential */
+    PrivateResidential = 3
+}
+/**
+ * Standard current types for charging connections
+ *
+ * @see https://github.com/openchargemap/ocm-system/blob/master/API/OCM.Net/OCM.API.Model/Base/CoreReferenceData.cs#L62
+ */
+declare enum StandardCurrentTypes {
+    /** Current type unknown */
+    Unknown = 0,
+    /** AC single phase */
+    AC_SinglePhase = 10,
+    /** AC three phase */
+    AC_ThreePhase = 20,
+    /** DC (Direct Current) */
+    DC = 30
+}
+/**
+ * Charging level IDs (ChargerType in OCM)
+ *
+ * @see https://github.com/openchargemap/ocm-system/blob/master/API/OCM.Net/OCM.API.Model/Base/CoreReferenceData.cs#L53
+ */
+declare enum ChargingLevels {
+    /** Level 1 - Standard household outlet (slow) */
+    Level1 = 1,
+    /** Level 2 - Dedicated EVSE (medium speed) */
+    Level2 = 2,
+    /** Level 3 - DC Fast Charging (rapid) */
+    Level3_DCFastCharging = 3
+}
+/**
+ * Submission status types for POI data quality
+ *
+ * @see https://github.com/openchargemap/ocm-system/blob/master/API/OCM.Net/OCM.API.Model/Base/CoreReferenceData.cs#L98
+ */
+declare enum StandardSubmissionStatusTypes {
+    /** Submitted and pending review */
+    Submitted_UnderReview = 1,
+    /** Imported from external source, unverified */
+    Imported_UnverifiedOrLowQuality = 100,
+    /** Imported and published */
+    Imported_Published = 200,
+    /** User submitted and published */
+    Submitted_Published = 1000
+}
+
+/**
+ * Reference data types from Open Charge Map
+ *
+ * These are lookup tables that should be cached locally as they rarely change.
+ * Fetch via GET /v4/referencedata
+ *
+ * @see https://github.com/openchargemap/ocm-system/blob/master/API/OCM.Net/OCM.API.Model/Base/CoreReferenceData.cs
+ */
+/**
+ * Country reference data
+ *
+ * @see https://github.com/openchargemap/ocm-system/blob/master/API/OCM.Net/OCM.API.Model/Base/CoreReferenceData.cs#L17
+ */
+interface Country {
+    ID: number;
+    Title: string;
+    /** ISO 3166-1 alpha-2 country code (e.g., "US", "GB", "CA") */
+    ISOCode: string;
+    /** Continent code (e.g., "NA", "EU", "AS") */
+    ContinentCode?: string;
+}
+/**
+ * Connection/plug type reference data
+ *
+ * Describes the physical connector type (J1772, CCS, CHAdeMO, etc.)
+ *
+ * @see https://github.com/openchargemap/ocm-system/blob/master/API/OCM.Net/OCM.API.Model/Base/ConnectionType.cs
+ */
+interface ConnectionType {
+    ID: number;
+    /** Display name (e.g., "CCS (Type 1)", "CHAdeMO") */
+    Title: string;
+    /** Official/formal name if different from Title */
+    FormalName?: string;
+    /** Whether this connector type is no longer in production */
+    IsDiscontinued?: boolean;
+    /** Whether this connector type is obsolete */
+    IsObsolete?: boolean;
+}
+/**
+ * Current type reference data (AC Single Phase, AC Three Phase, DC)
+ *
+ * @see https://github.com/openchargemap/ocm-system/blob/master/API/OCM.Net/OCM.API.Model/Base/CurrentType.cs
+ */
+interface CurrentType {
+    ID: number;
+    Title: string;
+    Description?: string;
+}
+/**
+ * Charger type / charging level reference data
+ *
+ * Indicates the charging speed category (Level 1, 2, 3)
+ *
+ * @see https://github.com/openchargemap/ocm-system/blob/master/API/OCM.Net/OCM.API.Model/Base/ChargerType.cs
+ */
+interface ChargerType {
+    ID: number;
+    Title: string;
+    Comments?: string;
+    /** Whether this charger type supports fast charging (typically Level 3/DC) */
+    IsFastChargeCapable?: boolean;
+}
+/**
+ * Status type reference data
+ *
+ * Indicates operational status (Operational, Not Operational, Planned, etc.)
+ *
+ * @see https://github.com/openchargemap/ocm-system/blob/master/API/OCM.Net/OCM.API.Model/Base/StatusType.cs
+ */
+interface StatusType {
+    ID: number;
+    Title: string;
+    /** Whether this status indicates the station is operational */
+    IsOperational?: boolean;
+    /** Whether users can select this status when submitting */
+    IsUserSelectable?: boolean;
+}
+/**
+ * Usage type reference data
+ *
+ * Indicates access restrictions (Public, Private, Membership Required, etc.)
+ *
+ * @see https://github.com/openchargemap/ocm-system/blob/master/API/OCM.Net/OCM.API.Model/Base/UsageType.cs
+ */
+interface UsageType {
+    ID: number;
+    Title: string;
+    /** Whether payment is required at the location */
+    IsPayAtLocation?: boolean;
+    /** Whether membership/account is required */
+    IsMembershipRequired?: boolean;
+    /** Whether an access key/card is required */
+    IsAccessKeyRequired?: boolean;
+}
+/**
+ * Charging network operator information
+ *
+ * @see https://github.com/openchargemap/ocm-system/blob/master/API/OCM.Net/OCM.API.Model/Base/OperatorInfo.cs
+ */
+interface OperatorInfo {
+    ID: number;
+    /** Operator/network name (e.g., "ChargePoint", "Electrify America") */
+    Title: string;
+    WebsiteURL?: string;
+    Comments?: string;
+    PhonePrimaryContact?: string;
+    PhoneSecondaryContact?: string;
+    /** Whether this is a private individual rather than a company */
+    IsPrivateIndividual?: boolean;
+    AddressInfo?: AddressInfo;
+    BookingURL?: string;
+    ContactEmail?: string;
+    FaultReportEmail?: string;
+    /** Whether edits to this operator's stations are restricted */
+    IsRestrictedEdit?: boolean;
+}
+/**
+ * Data provider information
+ *
+ * Indicates the source of the POI data (government registry, network API, user submission, etc.)
+ *
+ * @see https://github.com/openchargemap/ocm-system/blob/master/API/OCM.Net/OCM.API.Model/Base/DataProvider.cs
+ */
+interface DataProviderInfo {
+    ID: number;
+    Title: string;
+    WebsiteURL?: string;
+    Comments?: string;
+    DataProviderStatusType?: DataProviderStatusType;
+    /** Whether edits to this provider's data are restricted */
+    IsRestrictedEdit?: boolean;
+    /** Whether data is under an open data license */
+    IsOpenDataLicensed?: boolean;
+    /** Whether this is an approved import source */
+    IsApprovedImport?: boolean;
+    License?: string;
+    DateLastImported?: string;
+}
+/**
+ * Data provider status
+ */
+interface DataProviderStatusType {
+    ID: number;
+    Title: string;
+    IsProviderEnabled?: boolean;
+}
+/**
+ * Submission status type
+ *
+ * Indicates the review/quality status of POI data
+ *
+ * @see https://github.com/openchargemap/ocm-system/blob/master/API/OCM.Net/OCM.API.Model/Base/SubmissionStatusType.cs
+ */
+interface SubmissionStatusType {
+    ID: number;
+    Title: string;
+    /** Whether this status means the POI is publicly visible */
+    IsLive?: boolean;
+}
+/**
+ * Address/location information
+ *
+ * Used for both POI locations and operator addresses.
+ *
+ * @see https://github.com/openchargemap/ocm-system/blob/master/API/OCM.Net/OCM.API.Model/Base/AddressInfo.cs
+ */
+interface AddressInfo {
+    ID?: number;
+    /** Location name/title */
+    Title?: string;
+    AddressLine1?: string;
+    AddressLine2?: string;
+    Town?: string;
+    StateOrProvince?: string;
+    Postcode?: string;
+    Country?: Country;
+    CountryID?: number;
+    /** WGS84 latitude (-90 to 90) */
+    Latitude: number;
+    /** WGS84 longitude (-180 to 180) */
+    Longitude: number;
+    ContactTelephone1?: string;
+    ContactTelephone2?: string;
+    ContactEmail?: string;
+    /** Access instructions, hours, restrictions */
+    AccessComments?: string;
+    /** Related URL (location website, etc.) */
+    RelatedURL?: string;
+    /** Distance from search point (only in search results) */
+    Distance?: number;
+    /** Distance unit: 1 = km, 2 = miles */
+    DistanceUnit?: number;
+}
+/**
+ * Complete reference data response from GET /v4/referencedata
+ *
+ * Contains all lookup tables. Should be cached locally and refreshed periodically.
+ *
+ * @see https://github.com/openchargemap/ocm-system/blob/master/API/OCM.Net/OCM.API.Model/Base/CoreReferenceData.cs#L107
+ */
+interface CoreReferenceData {
+    ChargerTypes: ChargerType[];
+    ConnectionTypes: ConnectionType[];
+    CurrentTypes: CurrentType[];
+    Countries: Country[];
+    DataProviders: DataProviderInfo[];
+    Operators: OperatorInfo[];
+    StatusTypes: StatusType[];
+    UsageTypes: UsageType[];
+    SubmissionStatusTypes: SubmissionStatusType[];
+    UserCommentTypes?: UserCommentType[];
+    CheckinStatusTypes?: CheckinStatusType[];
+}
+/**
+ * User comment type reference data
+ */
+interface UserCommentType {
+    ID: number;
+    Title: string;
+}
+/**
+ * Check-in status type reference data
+ */
+interface CheckinStatusType {
+    ID: number;
+    Title: string;
+    /** Whether this is a positive check-in (successful charge) */
+    IsPositive?: boolean;
+    /** Whether this was an automated check-in */
+    IsAutomatedCheckin?: boolean;
+}
+
+/**
+ * Connection/plug information for a charging station
+ *
+ * Represents a single charging connector at a POI, including its type,
+ * power output, and availability status.
+ *
+ * @see https://github.com/openchargemap/ocm-system/blob/master/API/OCM.Net/OCM.API.Model/Base/ConnectionInfo.cs
+ */
+interface ConnectionInfo {
+    ID?: number;
+    /** Reference to ConnectionType.ID */
+    ConnectionTypeID?: number;
+    /** Expanded ConnectionType object (when verbose=true) */
+    ConnectionType?: ConnectionType;
+    /** Reference to StatusType.ID */
+    StatusTypeID?: number;
+    /** Expanded StatusType object */
+    StatusType?: StatusType;
+    /** Reference to ChargerType.ID (charging level) */
+    LevelID?: number;
+    /** Expanded ChargerType object */
+    Level?: ChargerType;
+    /** Maximum amperage */
+    Amps?: number;
+    /** Voltage */
+    Voltage?: number;
+    /** Power output in kilowatts */
+    PowerKW?: number;
+    /** Reference to CurrentType.ID (AC/DC) */
+    CurrentTypeID?: number;
+    /** Expanded CurrentType object */
+    CurrentType?: CurrentType;
+    /** Number of connectors of this type at this station */
+    Quantity?: number;
+    /** Additional notes about this connection */
+    Comments?: string;
+}
+/**
+ * User comment/check-in on a POI
+ *
+ * Represents user-submitted feedback including ratings, comments, and check-ins.
+ *
+ * @see https://github.com/openchargemap/ocm-system/blob/master/API/OCM.Net/OCM.API.Model/Base/UserComment.cs
+ */
+interface UserComment {
+    ID: number;
+    ChargePointID: number;
+    CommentTypeID?: number;
+    CommentType?: {
+        ID: number;
+        Title: string;
+    };
+    UserName?: string;
+    Comment?: string;
+    /** Rating from 1-5 */
+    Rating?: number;
+    RelatedURL?: string;
+    DateCreated: string;
+    User?: {
+        ID: number;
+        Username?: string;
+        ProfileImageURL?: string;
+    };
+    /** Reference to CheckinStatusType.ID */
+    CheckinStatusTypeID?: number;
+    CheckinStatusType?: {
+        ID: number;
+        Title: string;
+        IsPositive?: boolean;
+    };
+    /** Whether an editor has reviewed this comment */
+    IsActionedByEditor?: boolean;
+}
+/**
+ * Media item attached to a POI
+ *
+ * Photos or videos uploaded for a charging station.
+ *
+ * @see https://github.com/openchargemap/ocm-system/blob/master/API/OCM.Net/OCM.API.Model/Base/MediaItem.cs
+ */
+interface MediaItem {
+    ID: number;
+    ChargePointID: number;
+    /** Full URL to the media item */
+    ItemURL: string;
+    /** URL to thumbnail version */
+    ItemThumbnailURL?: string;
+    Comment?: string;
+    IsEnabled?: boolean;
+    IsVideo?: boolean;
+    IsFeaturedItem?: boolean;
+    IsExternalResource?: boolean;
+    User?: {
+        ID: number;
+        Username?: string;
+    };
+    DateCreated?: string;
+}
+/**
+ * Equipment information for a POI
+ */
+interface EquipmentInfo {
+    ID?: number;
+    SupplyType?: {
+        ID: number;
+        Title: string;
+    };
+    SupplyTypeID?: number;
+    GroundingType?: {
+        ID: number;
+        Title: string;
+    };
+    GroundingTypeID?: number;
+    Comments?: string;
+}
+/**
+ * Main POI (Point of Interest) / ChargePoint entity
+ *
+ * This is the core entity returned by the GET /v4/poi endpoint.
+ * Represents a single charging location which may have multiple connections.
+ *
+ * @see https://github.com/openchargemap/ocm-system/blob/master/API/OCM.Net/OCM.API.Model/Base/ChargePoint.cs
+ * @see https://github.com/openchargemap/ocm-system/blob/master/API/OCM.Net/OCM.API.Model/Extended/ChargePoint.cs
+ */
+interface ChargePoint {
+    /** Unique identifier for this POI */
+    ID: number;
+    /** UUID for this POI */
+    UUID?: string;
+    /**
+     * Address and geographic coordinates
+     * @see https://github.com/openchargemap/ocm-system/blob/master/API/OCM.Net/OCM.API.Model/Base/AddressInfo.cs
+     */
+    AddressInfo: AddressInfo;
+    /**
+     * List of charging connections/plugs at this location
+     * @see https://github.com/openchargemap/ocm-system/blob/master/API/OCM.Net/OCM.API.Model/Base/ConnectionInfo.cs
+     */
+    Connections?: ConnectionInfo[];
+    /** Total number of charging points/bays at this location */
+    NumberOfPoints?: number;
+    /** General comments about this location */
+    GeneralComments?: string;
+    /** Cost/pricing information (free-form text) */
+    UsageCost?: string;
+    /** Reference to OperatorInfo.ID */
+    OperatorID?: number;
+    /**
+     * Expanded operator information
+     * @see https://github.com/openchargemap/ocm-system/blob/master/API/OCM.Net/OCM.API.Model/Base/OperatorInfo.cs
+     */
+    OperatorInfo?: OperatorInfo;
+    /** Reference to UsageType.ID */
+    UsageTypeID?: number;
+    /**
+     * Expanded usage type (Public, Private, etc.)
+     * @see https://github.com/openchargemap/ocm-system/blob/master/API/OCM.Net/OCM.API.Model/Base/UsageType.cs
+     */
+    UsageType?: UsageType;
+    /** Reference to StatusType.ID */
+    StatusTypeID?: number;
+    /**
+     * Expanded status type (Operational, Not Operational, etc.)
+     * @see https://github.com/openchargemap/ocm-system/blob/master/API/OCM.Net/OCM.API.Model/Base/StatusType.cs
+     */
+    StatusType?: StatusType;
+    /** Reference to DataProvider.ID */
+    DataProviderID?: number;
+    /**
+     * Data source information
+     * @see https://github.com/openchargemap/ocm-system/blob/master/API/OCM.Net/OCM.API.Model/Base/DataProvider.cs
+     */
+    DataProvider?: DataProviderInfo;
+    /** External reference ID from the data provider */
+    DataProvidersReference?: string;
+    /** Reference to SubmissionStatusType.ID */
+    SubmissionStatusTypeID?: number;
+    /** Submission/review status */
+    SubmissionStatus?: SubmissionStatusType;
+    /** User comments and check-ins (when includecomments=true) */
+    UserComments?: UserComment[];
+    /** Photos and videos */
+    MediaItems?: MediaItem[];
+    Equipment?: EquipmentInfo;
+    /** When this POI was first added to OCM */
+    DateCreated?: string;
+    /** When this POI was last confirmed accurate */
+    DateLastConfirmed?: string;
+    /** When the status was last updated */
+    DateLastStatusUpdate?: string;
+    /** When this POI was last verified by a user */
+    DateLastVerified?: string;
+    /** Planned opening date (for PlannedForFuture status) */
+    DatePlanned?: string;
+    /** Custom metadata key-value pairs */
+    MetadataValues?: MetadataValue[];
+    /** Whether this POI was recently verified */
+    IsRecentlyVerified?: boolean;
+    /** Similarity score when detecting duplicates */
+    PercentageSimilarity?: number;
+}
+/**
+ * Metadata key-value pair
+ */
+interface MetadataValue {
+    ID: number;
+    MetadataFieldID: number;
+    MetadataFieldOptionID?: number;
+    ItemValue?: string;
+}
+/**
+ * Alias for ChargePoint
+ *
+ * OCM uses "POI" (Point of Interest) terminology in the API.
+ */
+type POI = ChargePoint;
+/**
+ * Search result with distance information
+ *
+ * When searching by location, AddressInfo includes Distance and DistanceUnit.
+ */
+interface POISearchResult extends ChargePoint {
+    AddressInfo: AddressInfo & {
+        /** Distance from search coordinates */
+        Distance?: number;
+        /** Distance unit: 1 = km, 2 = miles */
+        DistanceUnit?: number;
+    };
+}
+
+interface OCMClientOptions {
+    /**
+     * API key for authentication (required)
+     * Get one at https://openchargemap.org
+     */
+    apiKey: string;
+    /**
+     * Base URL for the API
+     * @default "https://api.openchargemap.io"
+     */
+    baseUrl?: string;
+    /**
+     * API version
+     * @default "v4"
+     */
+    version?: string;
+    /**
+     * Custom fetch implementation (useful for testing or server-side usage)
+     */
+    fetch?: typeof fetch;
+    /**
+     * Default timeout in milliseconds
+     * @default 30000
+     */
+    timeout?: number;
+    /**
+     * User session token for authenticated requests
+     */
+    sessionToken?: string;
+}
+declare class OCMClient {
+    private apiKey;
+    private baseUrl;
+    private version;
+    private fetchFn;
+    private timeout;
+    private sessionToken?;
+    constructor(options: OCMClientOptions);
+    /**
+     * Build URL with query parameters
+     */
+    private buildUrl;
+    /**
+     * Make a request with proper headers and error handling
+     */
+    private request;
+    /**
+     * Search for charging stations
+     *
+     * @example
+     * ```ts
+     * // Nearby search
+     * const stations = await client.searchPOI({
+     *   latitude: 37.7749,
+     *   longitude: -122.4194,
+     *   distance: 10,
+     *   distanceunit: "km"
+     * });
+     *
+     * // Fast chargers only
+     * const fastChargers = await client.searchPOI({
+     *   latitude: 37.7749,
+     *   longitude: -122.4194,
+     *   connectiontypeid: [32, 33], // CCS Combo
+     *   minpowerkw: 50
+     * });
+     * ```
+     */
+    searchPOI(params?: POISearchParams): Promise<ChargePoint[]>;
+    /**
+     * Get a specific POI by ID
+     */
+    getPOI(id: number, verbose?: boolean): Promise<ChargePoint | null>;
+    /**
+     * Search POIs and return GeoJSON format
+     */
+    searchPOIGeoJSON(params: Omit<POISearchParams, "output">): Promise<POIGeoJSONCollection>;
+    /**
+     * Get POIs modified since a specific date
+     * Useful for syncing/caching
+     */
+    getPOIUpdates(since: Date, params?: Omit<POISearchParams, "modifiedsince">): Promise<ChargePoint[]>;
+    /**
+     * Get all reference data (lookup tables)
+     * Results should be cached locally
+     *
+     * @example
+     * ```ts
+     * const refData = await client.getReferenceData();
+     * console.log(refData.ConnectionTypes);
+     * console.log(refData.StatusTypes);
+     * ```
+     */
+    getReferenceData(): Promise<CoreReferenceData>;
+    /**
+     * Authenticate user and get session token
+     * Store the sessionToken for subsequent authenticated requests
+     */
+    authenticate(credentials: AuthenticateParams): Promise<AuthenticateResponse>;
+    /**
+     * Set session token for authenticated requests
+     */
+    setSessionToken(token: string): void;
+    /**
+     * Clear session token
+     */
+    clearSession(): void;
+    /**
+     * Submit a new POI
+     * Requires authentication
+     */
+    submitPOI(poi: SubmitPOIParams): Promise<{
+        ID: number;
+    }>;
+    /**
+     * Submit a comment/check-in on a POI
+     * Requires authentication
+     */
+    submitComment(comment: SubmitCommentParams): Promise<{
+        ID: number;
+    }>;
+}
+/**
+ * Custom error class for OCM API errors
+ */
+declare class OCMAPIError extends Error {
+    status: number;
+    code?: string;
+    constructor(status: number, message: string);
+}
+/**
+ * Create an OCM client instance
+ */
+declare function createOCMClient(options: OCMClientOptions): OCMClient;
+
+export { type APIError, type AddressInfo, type AuthenticateParams, type AuthenticateResponse, type ChargePoint, type ChargerType, ChargingLevels, type CheckinStatusType, type ConnectionInfo, type ConnectionType, type CoreReferenceData, type Country, type CurrentType, type DataProviderInfo, type DataProviderStatusType, type DistanceUnit, type EquipmentInfo, type MediaItem, type MetadataValue, OCMAPIError, OCMClient, type OCMClientOptions, type OperatorInfo, type OutputFormat, type POI, type POIGeoJSONCollection, type POIGeoJSONFeature, type POISearchParams, type POISearchResult, type SortOrder, StandardConnectionTypes, StandardCurrentTypes, StandardStatusTypes, StandardSubmissionStatusTypes, StandardUsageTypes, type StatusType, type SubmissionStatusType, type SubmitCommentParams, type SubmitPOIParams, type UsageType, type UserComment, type UserCommentType, createOCMClient };