jslib-nightly/src/lib/ServerApi/ApiUrls.d.ts

SheerID JavaScript Library

import { DatabaseId, Locale } from '../types/types';
export declare const getVerificationUrl: () => string;
export declare const getVerificationStatusUrl: (verificationId: DatabaseId) => string;
export declare const getNewVerificationRequestUrl: () => string;
export declare const getProgramThemeUrl: (programId: DatabaseId, locale?: Locale) => string;
export declare const getAddSchoolRequestUrl: () => string;
export declare const getNewSmsCodeResendUrl: (verificationId: DatabaseId) => string;
export declare const getNewEmailCodeResendUrl: (verificationId: DatabaseId) => string;
/**
 * Get the version that was actually used
 * Comes from the contents of sheerid.js. The build process adds it there.
 * e.g. 1.59.0 or 1.46.0-alpha.575
 */
export declare const getPublishedVersion: () => string;
/**
 * Replace a CDN URL's dist tag with a more specific version
 */
export declare const urlMajorToSpecific: (cdnUrl: string, specificVersion: string) => string;
/**
 * Get the canonical URL from which to load all other jslib files
 */
export declare const getSheerIdScriptBasePath: () => string;
/**
 * Get the version that was _requested_ via script src
 * e.g. alpha or 1 or 1.59 or 1.59.0
 */
export declare const getRequestedVersion: () => string;