SDK Reference

    @proveanything/smartlinks

    npm install @proveanything/smartlinks
    View on npm →

    Namespaces

    Other

    location

    Functions for location operations

    5 functions4 types

    createGlobal

    Platform: Create a global location (super admin; requires features.adminApps) POST /platform/location

    public
    createGlobal(params: ) → Promise<>

    create

    Admin: Create a collection-scoped location POST /admin/collection/:collectionId/location

    public
    create(collectionId: string, params: ) → Promise<>

    search

    Admin: Search locations to pick during setup (combines collection + global) GET /admin/collection/:collectionId/location/search

    public
    search(collectionId: string,
    query:  = {}) → Promise<>

    getPublic

    Public: Fetch a global location by ID GET /public/location/:locationId

    public
    getPublic(locationId: string) → Promise<>

    getPublicForCollection

    Public: Fetch a location for a collection; returns either a collection-owned or global fallback GET /public/collection/:collectionId/location/:locationId

    public
    getPublicForCollection(collectionId: string,
    locationId: string) → Promise<>