@types/amplitude-js
Advanced tools
Comparing version
@@ -7,141 +7,140 @@ // Type definitions for Amplitude SDK 4.4.0 | ||
declare module amplitude { | ||
export as namespace amplitude; | ||
type Callback = (responseCode: number, responseBody: string, details?: { reason: string; }) => void; | ||
type LogReturn = number | void; | ||
type Callback = (responseCode: number, responseBody: string, details?: { reason: string; }) => void; | ||
type LogReturn = number | void; | ||
interface Config { | ||
apiEndpoint?: string; | ||
batchEvents?: boolean; | ||
cookieExpiration?: number; | ||
cookieName?: string; | ||
userId?: string; | ||
deviceId?: string; | ||
deviceIdFromUrlParam?: boolean; | ||
domain?: string; | ||
eventUploadPeriodMillis?: number; | ||
eventUploadThreshold?: number; | ||
forceHttps?: boolean; | ||
includeGclid?: boolean; | ||
includeReferrer?: boolean; | ||
includeUtm?: boolean; | ||
language?: string; | ||
logLevel?: 'DISABLE' | 'ERROR' | 'WARN' | 'INFO'; | ||
optOut?: boolean; | ||
platform?: string; | ||
saveEvents?: boolean; | ||
savedMaxCount?: number; | ||
saveParamsReferrerOncePerSession?: boolean; | ||
sessionTimeout?: number; | ||
trackingOptions?: { | ||
city?: boolean; | ||
country?: boolean; | ||
device_model?: boolean; | ||
dma?: boolean; | ||
ip_address?: boolean; | ||
language?: boolean; | ||
os_name?: boolean; | ||
os_version?: boolean; | ||
platform?: boolean; | ||
region?: boolean; | ||
version_name?: boolean; | ||
}, | ||
unsentKey?: string; | ||
unsentIdentifyKey?: string; | ||
uploadBatchSize?: number; | ||
} | ||
interface Config { | ||
apiEndpoint?: string; | ||
batchEvents?: boolean; | ||
cookieExpiration?: number; | ||
cookieName?: string; | ||
userId?: string; | ||
deviceId?: string; | ||
deviceIdFromUrlParam?: boolean; | ||
domain?: string; | ||
eventUploadPeriodMillis?: number; | ||
eventUploadThreshold?: number; | ||
forceHttps?: boolean; | ||
includeGclid?: boolean; | ||
includeReferrer?: boolean; | ||
includeUtm?: boolean; | ||
language?: string; | ||
logLevel?: 'DISABLE' | 'ERROR' | 'WARN' | 'INFO'; | ||
optOut?: boolean; | ||
platform?: string; | ||
saveEvents?: boolean; | ||
savedMaxCount?: number; | ||
saveParamsReferrerOncePerSession?: boolean; | ||
sessionTimeout?: number; | ||
trackingOptions?: { | ||
city?: boolean; | ||
country?: boolean; | ||
device_model?: boolean; | ||
dma?: boolean; | ||
ip_address?: boolean; | ||
language?: boolean; | ||
os_name?: boolean; | ||
os_version?: boolean; | ||
platform?: boolean; | ||
region?: boolean; | ||
version_name?: boolean; | ||
}, | ||
unsentKey?: string; | ||
unsentIdentifyKey?: string; | ||
uploadBatchSize?: number; | ||
} | ||
export class Identify { | ||
set(key: string, value: any): Identify; | ||
setOnce(key: string, value: any): Identify; | ||
add(key: string, value: number | string): Identify; | ||
append(key: string, value: any): Identify; | ||
prepend(key: string, value: any): Identify; | ||
export class Identify { | ||
set(key: string, value: any): Identify; | ||
setOnce(key: string, value: any): Identify; | ||
add(key: string, value: number | string): Identify; | ||
append(key: string, value: any): Identify; | ||
prepend(key: string, value: any): Identify; | ||
unset(key: string): Identify; | ||
} | ||
unset(key: string): Identify; | ||
} | ||
export class Revenue { | ||
export class Revenue { | ||
setProductId(productId: string): Revenue; | ||
setQuantity(quantity: number): Revenue; | ||
setPrice(price: number): Revenue; | ||
setRevenueType(revenueType: string): Revenue; | ||
setEventProperties(eventProperties: any): Revenue; | ||
} | ||
setProductId(productId: string): Revenue; | ||
setQuantity(quantity: number): Revenue; | ||
setPrice(price: number): Revenue; | ||
setRevenueType(revenueType: string): Revenue; | ||
setEventProperties(eventProperties: any): Revenue; | ||
} | ||
export class AmplitudeClient { | ||
export class AmplitudeClient { | ||
constructor(instanceName?: string); | ||
constructor(instanceName?: string); | ||
options: Config; | ||
options: Config; | ||
init(apiKey: string, userId?: string, config?: Config, callback?: (client: AmplitudeClient) => void): void; | ||
init(apiKey: string, userId?: string, config?: Config, callback?: (client: AmplitudeClient) => void): void; | ||
setVersionName(versionName: string): void; | ||
setVersionName(versionName: string): void; | ||
isNewSession(): boolean; | ||
setSessionId(sessionId: number): void; | ||
getSessionId(): number; | ||
isNewSession(): boolean; | ||
setSessionId(sessionId: number): void; | ||
getSessionId(): number; | ||
setDomain(domain: string): void; | ||
setUserId(userId: string): void; | ||
setDomain(domain: string): void; | ||
setUserId(userId: string): void; | ||
setDeviceId(id: string): void; | ||
regenerateDeviceId(): void; | ||
setDeviceId(id: string): void; | ||
regenerateDeviceId(): void; | ||
identify(identify_obj: Identify, opt_callback?: Callback): void; | ||
identify(identify_obj: Identify, opt_callback?: Callback): void; | ||
setUserProperties(properties: any): void; | ||
setGlobalUserProperties(properties: any): void; | ||
clearUserProperties(): void; | ||
setUserProperties(properties: any): void; | ||
setGlobalUserProperties(properties: any): void; | ||
clearUserProperties(): void; | ||
setOptOut(enable: boolean): void; | ||
setOptOut(enable: boolean): void; | ||
setGroup(groupType: string, groupName: string | string[]): void; | ||
setGroup(groupType: string, groupName: string | string[]): void; | ||
logEvent(event: string, data?: any, callback?: Callback): LogReturn; | ||
logEventWithGroups(event: string, data?: any, groups?: any, callback?: Callback): LogReturn; | ||
logRevenueV2(revenue_obj: Revenue): LogReturn; | ||
logRevenue(pric: number, quantity: number, product: string): LogReturn; | ||
logEventWithTimestamp(event: string, data?: any, timestamp?: number, callback?: Callback): LogReturn; | ||
} | ||
logEvent(event: string, data?: any, callback?: Callback): LogReturn; | ||
logEventWithGroups(event: string, data?: any, groups?: any, callback?: Callback): LogReturn; | ||
logRevenueV2(revenue_obj: Revenue): LogReturn; | ||
logRevenue(pric: number, quantity: number, product: string): LogReturn; | ||
logEventWithTimestamp(event: string, data?: any, timestamp?: number, callback?: Callback): LogReturn; | ||
} | ||
// Proxy methods that get executed on the default AmplitudeClient instance (not all client methods are proxied) | ||
// Proxy methods that get executed on the default AmplitudeClient instance (not all client methods are proxied) | ||
export function init(apiKey: string, userId?: string, options?: Config, callback?: (client: AmplitudeClient) => void): void; | ||
export function init(apiKey: string, userId?: string, options?: Config, callback?: (client: AmplitudeClient) => void): void; | ||
export function setVersionName(version: string): void; | ||
export function setVersionName(version: string): void; | ||
export function isNewSession(): boolean; | ||
export function getSessionId(): number; | ||
export function isNewSession(): boolean; | ||
export function getSessionId(): number; | ||
export function setDomain(domain: string): void; | ||
export function setDomain(domain: string): void; | ||
export function setUserId(userId: string): void; | ||
export function setUserId(userId: string): void; | ||
export function setDeviceId(id: string): void; | ||
export function regenerateDeviceId(): void; | ||
export function setDeviceId(id: string): void; | ||
export function regenerateDeviceId(): void; | ||
export function identify(identify: Identify, callback?: Callback): void; | ||
export function identify(identify: Identify, callback?: Callback): void; | ||
export function setUserProperties(properties: any): void; | ||
export function setGlobalUserProperties(properties: any): void; | ||
export function clearUserProperties(): void; | ||
export function setUserProperties(properties: any): void; | ||
export function setGlobalUserProperties(properties: any): void; | ||
export function clearUserProperties(): void; | ||
export function setOptOut(optOut: boolean): void; | ||
export function setOptOut(optOut: boolean): void; | ||
export function setGroup(groupType: string, groupName: string | string[]): void; | ||
export function setGroup(groupType: string, groupName: string | string[]): void; | ||
export function logEvent(event: string, data?: any, callback?: Callback): LogReturn; | ||
export function logEventWithGroups(event: string, data?: any, groups?: any, callback?: Callback): LogReturn; | ||
export function logRevenueV2(revenue_obj: Revenue): LogReturn; | ||
export function logRevenue(pric: number, quantity: number, product: string): LogReturn; | ||
export function logEventWithTimestamp(event: string, data?: any, timestamp?: number, callback?: Callback): LogReturn; | ||
export function logEvent(event: string, data?: any, callback?: Callback): LogReturn; | ||
export function logEventWithGroups(event: string, data?: any, groups?: any, callback?: Callback): LogReturn; | ||
export function logRevenueV2(revenue_obj: Revenue): LogReturn; | ||
export function logRevenue(pric: number, quantity: number, product: string): LogReturn; | ||
export function logEventWithTimestamp(event: string, data?: any, timestamp?: number, callback?: Callback): LogReturn; | ||
export function getInstance(instanceName?: string): AmplitudeClient; | ||
export const __VERSION__: string; | ||
export var options: Config; | ||
} | ||
export function getInstance(instanceName?: string): AmplitudeClient; | ||
export const __VERSION__: string; | ||
export var options: Config; |
{ | ||
"name": "@types/amplitude-js", | ||
"version": "4.4.0", | ||
"version": "4.4.1", | ||
"description": "TypeScript definitions for Amplitude SDK", | ||
@@ -19,3 +19,3 @@ "license": "MIT", | ||
"main": "", | ||
"types": "", | ||
"types": "index", | ||
"repository": { | ||
@@ -27,4 +27,4 @@ "type": "git", | ||
"dependencies": {}, | ||
"typesPublisherContentHash": "7abcbf2f4fdf54f92213c880714e31d71c2fc692ef5e37295b316b9d92a870ff", | ||
"typesPublisherContentHash": "d6c6faa7fee85b5c5026ea9976af1ceaacb1b60c3ad78d01949ba50aa306e4a0", | ||
"typeScriptVersion": "2.0" | ||
} |
@@ -5,3 +5,3 @@ # Installation | ||
# Summary | ||
This package contains type definitions for Amplitude SDK (https://github.com/amplitude/Amplitude-Javascript). | ||
This package contains type definitions for Amplitude SDK ( https://github.com/amplitude/Amplitude-Javascript ). | ||
@@ -12,3 +12,3 @@ # Details | ||
Additional Details | ||
* Last updated: Wed, 17 Oct 2018 15:53:21 GMT | ||
* Last updated: Fri, 25 Jan 2019 16:42:58 GMT | ||
* Dependencies: none | ||
@@ -15,0 +15,0 @@ * Global values: amplitude |
7445
-5.18%110
-0.9%