Merge ad93044 into 4ee0ebd

src/AnalyticsEventsService.ts

@@ -0,0 +1,26 @@
+import {AnalyticsConfig} from "./AnalyticsConfig";
+import {EventAPIResponse, EventPayload} from "./models";
+
+export interface AnalyticsEventService {
+
+    constructor(config: AnalyticsConfig);
+
+    /**
+     * Creates a new AnalyticsEventService with the following values defined
+     * as the default when making a report.
+     *
+     * @param payload - desired values to be applied. The new payload will
+     * override any overlapping values.
+     */
+    with(payload: EventPayload): AnalyticsEventService;
+
+    /**
+     * Reports an analytics event. Operand will throw an error if the request
+     * fails. The request will be sent via Beacon API so that requests are
+     * non-blocking.
+     *
+     * @param payload - desired values to be applied. The new payload will
+     * override any overlapping values.
+     */
+    report(payload: object): Promise<EventAPIResponse>;
+};