synup-js 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,911 @@
+interface PageInfo {
+    hasNextPage: boolean;
+    hasPreviousPage: boolean;
+    startCursor: string | null;
+    endCursor: string | null;
+    total?: number;
+}
+interface PaginatedResponse<T> {
+    success: boolean;
+    data: T[];
+    pageInfo: PageInfo;
+    totalCount?: number;
+    raw: any;
+}
+interface PaginationOptions {
+    first?: number;
+    after?: string;
+    before?: string;
+    last?: number;
+    fetchAll?: boolean;
+    pageSize?: number;
+}
+interface HttpCore {
+    apiGet<T = any>(path: string, params?: Record<string, any>): Promise<T>;
+    apiPost<T = any>(path: string, body: Record<string, any>): Promise<T>;
+    listingsGet<T = any>(locationId: string | number, path: string, params?: Record<string, any>): Promise<T>;
+    encodeLocationId(id: string | number): string;
+}
+
+interface Location {
+    id: string;
+    name?: string;
+    storeId?: string;
+    street?: string;
+    city?: string;
+    stateIso?: string;
+    postalCode?: string;
+    countryIso?: string;
+    phone?: string;
+    description?: string;
+    ownerEmail?: string;
+    ownerName?: string;
+    [key: string]: any;
+}
+interface CreateLocationInput {
+    name: string;
+    storeId: string;
+    street: string;
+    city: string;
+    stateIso: string;
+    postalCode: string;
+    countryIso: string;
+    phone: string;
+    subCategoryId: number;
+    description?: string;
+    ownerEmail?: string;
+    ownerName?: string;
+    [key: string]: any;
+}
+interface UpdateLocationInput {
+    id: string | number;
+    name?: string;
+    storeId?: string;
+    street?: string;
+    city?: string;
+    stateIso?: string;
+    postalCode?: string;
+    countryIso?: string;
+    phone?: string;
+    description?: string;
+    ownerEmail?: string;
+    ownerName?: string;
+    [key: string]: any;
+}
+
+interface LocationPaginatedResponse {
+    success: boolean;
+    locations: Location[];
+    pageInfo: PageInfo;
+    raw: any;
+}
+declare function createLocationMethods(http: HttpCore): {
+    /**
+     * Get locations for the account, with optional pagination or fetch-all.
+     *
+     * When fetchAll is true, returns a flat array of all locations.
+     * Otherwise returns a paginated response with locations, pageInfo, and raw data.
+     */
+    fetchAllLocations(options?: PaginationOptions): Promise<LocationPaginatedResponse | Location[]>;
+    /**
+     * Get locations by a list of IDs. Accepts numeric or base64-encoded IDs.
+     */
+    fetchLocationsByIds(locationIds: (string | number)[]): Promise<Location[]>;
+    /**
+     * Get locations that match the given store codes.
+     */
+    fetchLocationsByStoreCodes(storeCodes: string[]): Promise<Location[]>;
+    /**
+     * Search locations by keyword (name, address, or store ID).
+     */
+    searchLocations(query: string, options?: PaginationOptions & {
+        fields?: string[];
+    }): Promise<LocationPaginatedResponse | Location[]>;
+    /**
+     * Get all locations in a folder (including subfolders). Use folderId or folderName.
+     */
+    fetchLocationsByFolder(options: {
+        folderId?: string;
+        folderName?: string;
+    }): Promise<Location[]>;
+    /**
+     * Get locations that have any of the given tags.
+     */
+    fetchLocationsByTags(tags: string[], options?: PaginationOptions & {
+        archived?: boolean;
+    }): Promise<LocationPaginatedResponse | Location[]>;
+    /**
+     * Create a new location.
+     */
+    createLocation(input: CreateLocationInput): Promise<any>;
+    /**
+     * Update a location. Pass id plus any fields to change.
+     */
+    updateLocation(input: UpdateLocationInput): Promise<any>;
+    /**
+     * Archive one or more locations.
+     */
+    archiveLocations(locationIds: (string | number)[]): Promise<any>;
+    /**
+     * Reactivate previously archived locations.
+     */
+    activateLocations(locationIds: (string | number)[]): Promise<any>;
+    /**
+     * Cancel scheduled archival for the given locations.
+     */
+    cancelArchiveLocations(locationIds: (string | number)[], selectionType: string, changedBy: string): Promise<any>;
+};
+
+interface Listing {
+    id?: string;
+    site?: string;
+    syncStatus?: string;
+    displayStatus?: string;
+    listingUrl?: string;
+    [key: string]: any;
+}
+interface VoiceListing {
+    name?: string;
+    voiceIdentifier?: string;
+    syncStatus?: string;
+    [key: string]: any;
+}
+interface DuplicateListing {
+    id?: string;
+    site?: string;
+    listingUrl?: string;
+    [key: string]: any;
+}
+
+declare function createListingMethods(http: HttpCore): {
+    /**
+     * Get premium (directory) listings for a location (Google, Yelp, etc.).
+     */
+    fetchPremiumListings(locationId: string | number): Promise<Listing[]>;
+    /**
+     * Get voice assistant listings for a location (Google, Alexa, Siri, etc.).
+     */
+    fetchVoiceListings(locationId: string | number): Promise<VoiceListing[]>;
+    /**
+     * Get additional (non-premium) listings for a location.
+     */
+    fetchAdditionalListings(locationId: string | number): Promise<Listing[]>;
+    /**
+     * Get duplicate listings detected for a location.
+     */
+    fetchDuplicateListings(locationId: string | number): Promise<DuplicateListing[]>;
+    /**
+     * Get a rollup of duplicate listings across all locations,
+     * with optional tag filter and pagination.
+     */
+    fetchAllDuplicateListings(options?: {
+        tag?: string;
+        page?: number;
+    }): Promise<any>;
+    /**
+     * Get AI-generated listing suggestions for a location.
+     */
+    fetchAiListings(locationId: string | number): Promise<any>;
+    /**
+     * Mark one or more listing items as duplicate for a location.
+     */
+    markListingsAsDuplicate(locationId: string | number, listingItemIds: string[]): Promise<any>;
+    /**
+     * Clear duplicate status for listing items.
+     */
+    markListingsAsNotDuplicate(locationId: string | number, listingItemIds: string[]): Promise<any>;
+};
+
+interface InteractionFilters {
+    siteUrls?: string[];
+    startDate?: string;
+    endDate?: string;
+    category?: string;
+    ratingFilters?: number[];
+}
+interface Interaction {
+    id: string;
+    content?: string;
+    rating?: number;
+    siteName?: string;
+    siteUrl?: string;
+    reviewerName?: string;
+    publishedAt?: string;
+    category?: string;
+    responses?: any[];
+    [key: string]: any;
+}
+interface InteractionEdge {
+    node: Interaction;
+    cursor: string;
+}
+interface InteractionPageInfo {
+    hasNextPage: boolean;
+    hasPreviousPage: boolean;
+}
+interface InteractionsData {
+    edges: InteractionEdge[];
+    pageInfo: InteractionPageInfo;
+    totalCount?: number;
+}
+interface InteractionResponse {
+    success: boolean;
+    interactions: Interaction[];
+    pageInfo: {
+        hasNextPage: boolean;
+        hasPreviousPage: boolean;
+        startCursor: string | null;
+        endCursor: string | null;
+    };
+    totalCount?: number;
+    raw: any;
+    [key: string]: any;
+}
+interface ReviewSettings {
+    [key: string]: any;
+}
+interface ReviewAnalytics {
+    [key: string]: any;
+}
+interface ReviewSiteConfig {
+    [key: string]: any;
+}
+interface ReviewDetails {
+    [key: string]: any;
+}
+interface ReviewPhrase {
+    phrase?: string;
+    count?: number;
+    sentiment?: string;
+    [key: string]: any;
+}
+interface ReviewSiteUrl {
+    name: string;
+    url: string;
+    [key: string]: any;
+}
+interface RespondToReviewInput {
+    interactionId: string;
+    responseContent: string;
+}
+interface EditReviewResponseInput {
+    reviewId: string;
+    responseId: string;
+    responseContent: string;
+}
+interface ReviewPhrasesOptions {
+    locationIds: string[];
+    siteUrls?: string[];
+    startDate?: string;
+    endDate?: string;
+}
+
+declare function createReviewMethods(http: HttpCore): {
+    /**
+     * Get reviews/interactions for a location with pagination and filters.
+     * When fetchAll is true, returns a flat array of all interactions.
+     * Otherwise returns a paginated response object.
+     */
+    fetchInteractions(locationId: string | number, options?: PaginationOptions & InteractionFilters): Promise<InteractionResponse | Interaction[]>;
+    /**
+     * Get review source settings for a location.
+     */
+    fetchReviewSettings(locationId: string | number): Promise<ReviewSettings>;
+    /**
+     * Get overall review analytics for a location.
+     */
+    fetchReviewAnalyticsOverview(locationId: string | number, options?: {
+        startDate?: string;
+        endDate?: string;
+    }): Promise<ReviewAnalytics>;
+    /**
+     * Get review analytics over time for a location.
+     */
+    fetchReviewAnalyticsTimeline(locationId: string | number, options?: {
+        startDate?: string;
+        endDate?: string;
+    }): Promise<ReviewAnalytics>;
+    /**
+     * Get review analytics broken down by site for a location.
+     */
+    fetchReviewAnalyticsSitesStats(locationId: string | number, options?: {
+        startDate?: string;
+        endDate?: string;
+    }): Promise<ReviewAnalytics>;
+    /**
+     * Get eligible review sources and site config for the account.
+     */
+    fetchReviewSiteConfig(): Promise<ReviewSiteConfig[]>;
+    /**
+     * Get detailed information for specific reviews by interaction IDs.
+     */
+    fetchReviewDetails(interactionIds: string[]): Promise<ReviewDetails>;
+    /**
+     * Get review phrase analysis for given locations.
+     */
+    fetchReviewPhrases(options: ReviewPhrasesOptions): Promise<ReviewPhrase[]>;
+    /**
+     * Post a reply to a review/interaction.
+     */
+    respondToReview(interactionId: string, responseContent: string): Promise<Record<string, any>>;
+    /**
+     * Edit an existing reply to a review.
+     */
+    editReviewResponse(reviewId: string, responseId: string, responseContent: string): Promise<Record<string, any>>;
+    /**
+     * Archive (hide) a reply to a review.
+     */
+    archiveReviewResponse(responseId: string): Promise<Record<string, any>>;
+    /**
+     * Set or update review source URLs for a location.
+     */
+    editReviewSettings(locationId: string | number, siteUrls: ReviewSiteUrl[]): Promise<Record<string, any>>;
+};
+
+interface Keyword {
+    id: string;
+    name?: string;
+    [key: string]: any;
+}
+interface KeywordPerformance {
+    id?: string;
+    name?: string;
+    [key: string]: any;
+}
+interface KeywordPerformanceOptions {
+    fromDate?: string;
+    toDate?: string;
+}
+interface AddKeywordsInput {
+    locationId: string | number;
+    keywords: string[];
+}
+interface RankingAnalyticsTimelineInput {
+    locationIds: string[];
+    fromDate: string;
+    toDate: string;
+    source: string[];
+}
+interface RankingSitewiseHistogramInput {
+    locationIds: string[];
+    fromDate: string;
+    toDate: string;
+    source: string[];
+}
+interface RankingTimelineEntry {
+    [key: string]: any;
+}
+interface RankingHistogramEntry {
+    [key: string]: any;
+}
+
+declare function createKeywordMethods(http: HttpCore): {
+    /**
+     * Get all keywords tracked for a location.
+     */
+    fetchKeywords(locationId: string | number): Promise<Keyword[]>;
+    /**
+     * Get ranking performance for a location's keywords over an optional date range.
+     */
+    fetchKeywordsPerformance(locationId: string | number, options?: KeywordPerformanceOptions): Promise<KeywordPerformance[]>;
+    /**
+     * Add keywords to a location for ranking tracking.
+     */
+    addKeywords(locationId: string | number, keywords: string[]): Promise<Keyword[]>;
+    /**
+     * Archive a keyword so it is no longer tracked.
+     */
+    archiveKeyword(keywordId: string): Promise<Record<string, any>>;
+    /**
+     * Get ranking analytics timeline (positions over time) for locations and a source.
+     */
+    fetchRankingAnalyticsTimeline(input: RankingAnalyticsTimelineInput): Promise<RankingTimelineEntry[]>;
+    /**
+     * Get ranking histogram by keyword count for locations and a source.
+     */
+    fetchRankingSitewiseHistogram(input: RankingSitewiseHistogramInput): Promise<RankingHistogramEntry[]>;
+};
+
+interface ReviewCampaign {
+    id?: string;
+    name?: string;
+    locationId?: string;
+    [key: string]: any;
+}
+interface CustomerInput {
+    name: string;
+    email?: string;
+    phone?: string;
+    [key: string]: any;
+}
+interface CreateCampaignInput {
+    locationId: string | number;
+    name: string;
+    locationCustomers: CustomerInput[];
+    screening?: boolean;
+    landingPageTemplate?: Record<string, any>;
+    openingEmailTemplate?: Record<string, any>;
+    smsTemplate?: Record<string, any>;
+    emailDetails?: Record<string, any>;
+    smsDetails?: Record<string, any>;
+}
+interface AddCampaignCustomersInput {
+    reviewCampaignId: string;
+    locationCustomers: CustomerInput[];
+}
+interface ReviewCampaignCustomersResponse {
+    [key: string]: any;
+}
+interface CreateCampaignResponse {
+    reviewCampaign?: ReviewCampaign;
+    success?: boolean;
+    errors?: any[];
+    [key: string]: any;
+}
+interface AddCustomersResponse {
+    [key: string]: any;
+}
+
+declare function createCampaignMethods(http: HttpCore): {
+    /**
+     * Get review campaigns for a location, optionally filtered by date range.
+     */
+    fetchReviewCampaigns(locationId: string | number, options?: {
+        startDate?: string;
+        endDate?: string;
+    }): Promise<ReviewCampaign[]>;
+    /**
+     * Get customer details for a specific review campaign.
+     */
+    fetchReviewCampaignCustomers(reviewCampaignId: string): Promise<ReviewCampaignCustomersResponse>;
+    /**
+     * Create a review campaign for a location with customers and optional templates.
+     */
+    createReviewCampaign(input: CreateCampaignInput): Promise<CreateCampaignResponse>;
+    /**
+     * Add customers to an existing review campaign.
+     */
+    addReviewCampaignCustomers(reviewCampaignId: string, locationCustomers: CustomerInput[]): Promise<AddCustomersResponse>;
+};
+
+interface GoogleAnalytics {
+    [key: string]: any;
+}
+interface BingAnalytics {
+    [key: string]: any;
+}
+interface FacebookAnalytics {
+    [key: string]: any;
+}
+
+declare function createAnalyticsMethods(http: HttpCore): {
+    /**
+     * Get Google (GMB) profile analytics for a location.
+     */
+    fetchGoogleAnalytics(locationId: string | number, options?: {
+        fromDate?: string;
+        toDate?: string;
+    }): Promise<GoogleAnalytics>;
+    /**
+     * Get Bing profile analytics for a location.
+     */
+    fetchBingAnalytics(locationId: string | number, options?: {
+        fromDate?: string;
+        toDate?: string;
+    }): Promise<BingAnalytics>;
+    /**
+     * Get Facebook page analytics for a location.
+     */
+    fetchFacebookAnalytics(locationId: string | number, options?: {
+        fromDate?: string;
+        toDate?: string;
+    }): Promise<FacebookAnalytics>;
+};
+
+interface Photo {
+    [key: string]: any;
+}
+interface PhotoInput {
+    photo: string;
+    type: 'LOGO' | 'COVER' | 'ADDITIONAL';
+    partnerMediaId?: string;
+}
+
+declare function createPhotoMethods(http: HttpCore): {
+    /**
+     * Get photos and media attached to a location.
+     */
+    fetchLocationPhotos(locationId: string | number): Promise<Photo[]>;
+    /**
+     * Add one or more photos to a location.
+     */
+    addLocationPhotos(locationId: string | number, photos: PhotoInput[]): Promise<Record<string, any>>;
+    /**
+     * Remove photos from a location by photo IDs.
+     */
+    removeLocationPhotos(locationId: string | number, photoIds: string[]): Promise<Record<string, any>>;
+    /**
+     * Star or unstar location photos.
+     */
+    starLocationPhotos(locationId: string | number, mediaIds: string[], starred: boolean): Promise<Record<string, any>>;
+    /**
+     * Get the processing status for a bulk photo upload request.
+     */
+    fetchPhotoUploadStatus(requestId: string): Promise<Record<string, any>>;
+};
+
+interface Folder {
+    [key: string]: any;
+}
+
+declare function createFolderMethods(http: HttpCore): {
+    /**
+     * Get all folders as a flat list.
+     */
+    fetchFoldersFlat(): Promise<Folder[]>;
+    /**
+     * Get all folders as a nested tree structure.
+     */
+    fetchFoldersTree(): Promise<Folder[]>;
+    /**
+     * Get details for a specific folder by ID or name.
+     */
+    fetchFolderDetails(options: {
+        folderId?: string;
+        folderName?: string;
+    }): Promise<Folder>;
+    /**
+     * Create a folder to organize locations.
+     */
+    createFolder(name: string, options?: {
+        parentFolder?: string;
+        parentFolderName?: string;
+    }): Promise<Record<string, any>>;
+    /**
+     * Rename an existing folder.
+     */
+    renameFolder(oldName: string, newName: string): Promise<Record<string, any>>;
+    /**
+     * Delete a folder by name. Locations in the folder are not deleted.
+     */
+    deleteFolder(name: string): Promise<Record<string, any>>;
+    /**
+     * Add locations to a folder. Folder is created if it does not exist.
+     */
+    addLocationsToFolder(folderName: string, locationIds: (string | number)[]): Promise<Record<string, any>>;
+    /**
+     * Remove locations from their current folder.
+     */
+    removeLocationsFromFolder(locationIds: (string | number)[]): Promise<Record<string, any>>;
+};
+
+interface Tag {
+    [key: string]: any;
+}
+
+declare function createTagMethods(http: HttpCore): {
+    /**
+     * Get all tags defined in the account.
+     */
+    fetchTags(): Promise<Tag[]>;
+    /**
+     * Add a tag to a location. Tag is created if it does not exist.
+     */
+    addLocationTag(locationId: string | number, tag: string): Promise<Record<string, any>>;
+    /**
+     * Remove a tag from a location.
+     */
+    removeLocationTag(locationId: string | number, tag: string): Promise<Record<string, any>>;
+};
+
+interface User {
+    [key: string]: any;
+}
+interface Role {
+    [key: string]: any;
+}
+interface CreateUserInput {
+    email: string;
+    roleId: string;
+    firstName: string;
+    lastName?: string;
+    directCustomer?: boolean;
+    [key: string]: any;
+}
+interface UpdateUserInput {
+    userId: string;
+    email?: string;
+    roleId?: string;
+    firstName?: string;
+    lastName?: string;
+    phone?: string;
+    archived?: boolean;
+    directCustomer?: boolean;
+    [key: string]: any;
+}
+
+declare function createUserMethods(http: HttpCore): {
+    /**
+     * Get all users in the account.
+     */
+    fetchUsers(): Promise<User[]>;
+    /**
+     * Get users by a list of user IDs.
+     */
+    fetchUsersByIds(userIds: string[]): Promise<User[]>;
+    /**
+     * Get resources (locations, folders, etc.) assigned to a specific user.
+     */
+    fetchUserResources(userId: string): Promise<any[]>;
+    /**
+     * Get all roles defined in the account.
+     */
+    fetchRoles(): Promise<Role[]>;
+    /**
+     * Create a user in the account with the given role.
+     */
+    createUser(input: CreateUserInput): Promise<Record<string, any>>;
+    /**
+     * Update a user. Pass userId and any fields to change.
+     */
+    updateUser(input: UpdateUserInput): Promise<Record<string, any>>;
+    /**
+     * Assign locations to a user.
+     */
+    addUserLocations(userId: string, locationIds: (string | number)[]): Promise<Record<string, any>>;
+    /**
+     * Remove location assignments from a user.
+     */
+    removeUserLocations(userId: string, locationIds: (string | number)[]): Promise<Record<string, any>>;
+    /**
+     * Assign folders to a user.
+     */
+    addUserFolders(userId: string, folderIds: string[]): Promise<Record<string, any>>;
+    /**
+     * Remove folder assignments from a user.
+     */
+    removeUserFolders(userId: string, folderIds: string[]): Promise<Record<string, any>>;
+    /**
+     * Create a user and a folder, then assign the folder to the user in one call.
+     */
+    addUserAndFolder(input: Record<string, any>): Promise<Record<string, any>>;
+};
+
+interface ConnectedAccount {
+    [key: string]: any;
+}
+interface OAuthConnectUrl {
+    [key: string]: any;
+}
+interface ConnectedAccountListing {
+    [key: string]: any;
+}
+interface ConnectedAccountFolder {
+    [key: string]: any;
+}
+interface ConnectionSuggestion {
+    [key: string]: any;
+}
+interface ConnectedAccountDetails {
+    [key: string]: any;
+}
+
+declare function createConnectionMethods(http: HttpCore): {
+    /**
+     * Get a URL to connect a Google or Facebook profile to a location.
+     */
+    getOauthConnectUrl(locationId: string | number, site: string, successUrl: string, errorUrl: string): Promise<OAuthConnectUrl>;
+    /**
+     * Disconnect a Google or Facebook profile from a location.
+     */
+    oauthDisconnect(locationId: string | number, site: string): Promise<Record<string, any>>;
+    /**
+     * Get a URL to connect a Google account for bulk use across locations.
+     */
+    connectGoogleAccount(successUrl: string, errorUrl: string): Promise<Record<string, any>>;
+    /**
+     * Get a URL to connect a Facebook account for bulk use across locations.
+     */
+    connectFacebookAccount(successUrl: string, errorUrl: string): Promise<Record<string, any>>;
+    /**
+     * Disconnect a Google connected account (bulk).
+     */
+    disconnectGoogleAccount(connectedAccountId: string): Promise<Record<string, any>>;
+    /**
+     * Disconnect a Facebook connected account (bulk).
+     */
+    disconnectFacebookAccount(connectedAccountId: string): Promise<Record<string, any>>;
+    /**
+     * Get connected third-party accounts with optional filters.
+     */
+    fetchConnectedAccounts(options?: {
+        publisher?: string;
+        status?: string;
+        page?: number;
+        perPage?: number;
+    }): Promise<Record<string, any>>;
+    /**
+     * Get detailed information about a specific connected account.
+     */
+    fetchConnectedAccountDetails(connectedAccountId: string): Promise<ConnectedAccountDetails>;
+    /**
+     * Get folders (business groups) under a connected Google account.
+     */
+    fetchConnectedAccountFolders(connectedAccountId: string, options?: {
+        folderName?: string;
+    }): Promise<ConnectedAccountFolder[]>;
+    /**
+     * Get listings the connected Google/Facebook account has access to.
+     */
+    fetchConnectedAccountListings(connectedAccountId: string, options?: {
+        locationInfo?: string;
+        page?: number;
+        perPage?: number;
+    }): Promise<Record<string, any>>;
+    /**
+     * Get suggested matches between a connected account's listings and Synup locations.
+     */
+    fetchConnectionSuggestions(connectedAccountId: string, options?: {
+        page?: number;
+        perPage?: number;
+    }): Promise<Record<string, any>>;
+    /**
+     * Trigger matching of Google/Facebook profile locations to Synup locations.
+     */
+    triggerConnectedAccountMatches(connectedAccountIds: string[]): Promise<Record<string, any>>;
+    /**
+     * Confirm suggested matches between connected account listings and Synup locations.
+     */
+    confirmConnectedAccountMatches(matchRecordIds: string[]): Promise<Record<string, any>>;
+    /**
+     * Link a Synup location to a listing from a connected Google/Facebook account.
+     */
+    connectListing(locationId: string | number, connectedAccountListingId: string, connectedAccountId: string): Promise<Record<string, any>>;
+    /**
+     * Unlink a location from its Google or Facebook listing.
+     */
+    disconnectListing(locationId: string | number, site: string): Promise<Record<string, any>>;
+    /**
+     * Create a Google Business Profile listing for an existing Synup location.
+     */
+    createGmbListing(locationId: string | number, connectedAccountId: string, options?: {
+        folderId?: string;
+    }): Promise<Record<string, any>>;
+};
+
+interface GridReport {
+    [key: string]: any;
+}
+interface CreateGridReportInput {
+    locationId: string | number;
+    keywords: string[];
+    businessName: string;
+    businessStreet: string;
+    businessCity: string;
+    businessState: string;
+    businessCountry: string;
+    latitude: number;
+    longitude: number;
+    distance: number;
+    distanceUnit: string;
+    gridSize: number;
+    [key: string]: any;
+}
+interface GridReportFilterOptions {
+    searchString?: string;
+    gridSize?: number;
+    fromDate?: string;
+    toDate?: string;
+    sortField?: string;
+    sortOrder?: string;
+    pageSize?: number;
+    page?: number;
+    [key: string]: any;
+}
+
+declare function createGridRankMethods(http: HttpCore): {
+    /**
+     * Create a Local Rank Grid report.
+     */
+    createGridReport(input: CreateGridReportInput): Promise<Record<string, any>>;
+    /**
+     * Get a Local Rank Grid report by its ID.
+     */
+    fetchGridReport(reportId: string): Promise<GridReport>;
+    /**
+     * Get all Local Rank Grid reports for a location with optional filters.
+     */
+    fetchLocationGridReports(locationId: string | number, options?: GridReportFilterOptions): Promise<{
+        reports: GridReport[];
+        total: number | undefined;
+    }>;
+};
+
+interface PlanSite {
+    [key: string]: any;
+}
+interface Country {
+    [key: string]: any;
+}
+interface Subscription {
+    [key: string]: any;
+}
+interface TemporaryCloseInput {
+    name: string;
+    startDate: string;
+    startTime: string;
+    endDate: string;
+    locationId: string | number;
+    [key: string]: any;
+}
+
+declare function createAccountMethods(http: HttpCore): {
+    /**
+     * Get supported directories and site details for your plan.
+     */
+    fetchPlanSites(): Promise<PlanSite[]>;
+    /**
+     * Get supported countries and states.
+     */
+    fetchCountries(): Promise<Country[]>;
+    /**
+     * Get active subscriptions for the account.
+     */
+    fetchSubscriptions(): Promise<Subscription[]>;
+    /**
+     * Get OAuth connection status for a location.
+     */
+    fetchConnectionInfo(locationId: string | number): Promise<Record<string, any>>;
+    /**
+     * Create an automation that temporarily closes a location and reopens on a set date.
+     */
+    createTemporaryCloseAutomation(input: TemporaryCloseInput): Promise<Record<string, any>>;
+};
+
+/**
+ * Encode a numeric location ID to base64 format, or return as-is if already encoded.
+ */
+declare function encodeLocationId(idValue: string | number): string;
+interface SynupClientOptions {
+    apiKey: string;
+    baseUrl?: string;
+}
+/**
+ * Client for the Synup v4 API.
+ *
+ * @example
+ * ```ts
+ * const client = new SynupClient({ apiKey: 'YOUR_API_KEY' });
+ * const locations = await client.fetchAllLocations({ first: 10 });
+ * ```
+ */
+declare class SynupClient {
+    private baseUrl;
+    private headers;
+    constructor(options: SynupClientOptions);
+    /**
+     * GET request to an account-level API endpoint.
+     */
+    apiGet<T = any>(path: string, params?: Record<string, any>): Promise<T>;
+    /**
+     * POST request to an account-level API endpoint.
+     */
+    apiPost<T = any>(path: string, body: Record<string, any>): Promise<T>;
+    /**
+     * GET request to a location-scoped API endpoint.
+     */
+    listingsGet<T = any>(locationId: string | number, path: string, params?: Record<string, any>): Promise<T>;
+}
+interface SynupClient extends ReturnType<typeof createLocationMethods>, ReturnType<typeof createListingMethods>, ReturnType<typeof createReviewMethods>, ReturnType<typeof createKeywordMethods>, ReturnType<typeof createCampaignMethods>, ReturnType<typeof createAnalyticsMethods>, ReturnType<typeof createPhotoMethods>, ReturnType<typeof createFolderMethods>, ReturnType<typeof createTagMethods>, ReturnType<typeof createUserMethods>, ReturnType<typeof createConnectionMethods>, ReturnType<typeof createGridRankMethods>, ReturnType<typeof createAccountMethods> {
+}
+
+/**
+ * Error thrown when the Synup API returns a non-2xx response.
+ */
+declare class SynupAPIError extends Error {
+    statusCode: number | null;
+    responseBody: string | null;
+    constructor(message: string, statusCode?: number, responseBody?: string);
+}
+
+export { type AddCampaignCustomersInput, type AddCustomersResponse, type AddKeywordsInput, type BingAnalytics, type ConnectedAccount, type ConnectedAccountDetails, type ConnectedAccountFolder, type ConnectedAccountListing, type ConnectionSuggestion, type Country, type CreateCampaignInput, type CreateCampaignResponse, type CreateGridReportInput, type CreateLocationInput, type CreateUserInput, type CustomerInput, type DuplicateListing, type EditReviewResponseInput, type FacebookAnalytics, type Folder, type GoogleAnalytics, type GridReport, type GridReportFilterOptions, type HttpCore, type Interaction, type InteractionEdge, type InteractionFilters, type InteractionPageInfo, type InteractionResponse, type InteractionsData, type Keyword, type KeywordPerformance, type KeywordPerformanceOptions, type Listing, type Location, type OAuthConnectUrl, type PageInfo, type PaginatedResponse, type PaginationOptions, type Photo, type PhotoInput, type PlanSite, type RankingAnalyticsTimelineInput, type RankingHistogramEntry, type RankingSitewiseHistogramInput, type RankingTimelineEntry, type RespondToReviewInput, type ReviewAnalytics, type ReviewCampaign, type ReviewCampaignCustomersResponse, type ReviewDetails, type ReviewPhrase, type ReviewPhrasesOptions, type ReviewSettings, type ReviewSiteConfig, type ReviewSiteUrl, type Role, type Subscription, SynupAPIError, SynupClient, type SynupClientOptions, type Tag, type TemporaryCloseInput, type UpdateLocationInput, type UpdateUserInput, type User, type VoiceListing, encodeLocationId };