@athoscommerce/beacon 1.0.0

package/src/client/models/ClickthroughResultsInner.ts

@@ -0,0 +1,76 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * analytics.athoscommerce.net
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.2.48
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import type { ResultProduct } from './ResultProduct';
+import {
+    instanceOfResultProduct,
+    ResultProductFromJSON,
+    ResultProductFromJSONTyped,
+    ResultProductToJSON,
+} from './ResultProduct';
+import type { ResultResultBanner } from './ResultResultBanner';
+import {
+    instanceOfResultResultBanner,
+    ResultResultBannerFromJSON,
+    ResultResultBannerFromJSONTyped,
+    ResultResultBannerToJSON,
+} from './ResultResultBanner';
+
+/**
+ * @type ClickthroughResultsInner
+ * 
+ * @export
+ */
+export type ClickthroughResultsInner = ResultProduct | ResultResultBanner;
+
+export function ClickthroughResultsInnerFromJSON(json: any): ClickthroughResultsInner {
+    return ClickthroughResultsInnerFromJSONTyped(json, false);
+}
+
+export function ClickthroughResultsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): ClickthroughResultsInner {
+    if (json == null) {
+        return json;
+    }
+    if (typeof json !== 'object') {
+        return json;
+    }
+    if (instanceOfResultProduct(json)) {
+        return ResultProductFromJSONTyped(json, true);
+    }
+    if (instanceOfResultResultBanner(json)) {
+        return ResultResultBannerFromJSONTyped(json, true);
+    }
+    return {} as any;
+}
+
+export function ClickthroughResultsInnerToJSON(json: any): any {
+    return ClickthroughResultsInnerToJSONTyped(json, false);
+}
+
+export function ClickthroughResultsInnerToJSONTyped(value?: ClickthroughResultsInner | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+    if (typeof value !== 'object') {
+        return value;
+    }
+    if (instanceOfResultProduct(value)) {
+        return ResultProductToJSON(value as ResultProduct);
+    }
+    if (instanceOfResultResultBanner(value)) {
+        return ResultResultBannerToJSON(value as ResultResultBanner);
+    }
+    return {};
+}
+

package/src/client/models/ClickthroughResultsSchema.ts

@@ -0,0 +1,83 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * analytics.athoscommerce.net
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.2.48
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { ClickthroughResultsInner } from './ClickthroughResultsInner';
+import {
+    ClickthroughResultsInnerFromJSON,
+    ClickthroughResultsInnerFromJSONTyped,
+    ClickthroughResultsInnerToJSON,
+    ClickthroughResultsInnerToJSONTyped,
+} from './ClickthroughResultsInner';
+
+/**
+ * 
+ * @export
+ * @interface ClickthroughResultsSchema
+ */
+export interface ClickthroughResultsSchema {
+    /**
+     * Unique ID returned in each API response
+     * @type {string}
+     * @memberof ClickthroughResultsSchema
+     */
+    responseId: string;
+    /**
+     * List of tracked result(s). Can be a result that is either a product or a banner.
+     * @type {Array<ClickthroughResultsInner>}
+     * @memberof ClickthroughResultsSchema
+     */
+    results: Array<ClickthroughResultsInner>;
+}
+
+/**
+ * Check if a given object implements the ClickthroughResultsSchema interface.
+ */
+export function instanceOfClickthroughResultsSchema(value: object): value is ClickthroughResultsSchema {
+    if (!('responseId' in value) || value['responseId'] === undefined) return false;
+    if (!('results' in value) || value['results'] === undefined) return false;
+    return true;
+}
+
+export function ClickthroughResultsSchemaFromJSON(json: any): ClickthroughResultsSchema {
+    return ClickthroughResultsSchemaFromJSONTyped(json, false);
+}
+
+export function ClickthroughResultsSchemaFromJSONTyped(json: any, ignoreDiscriminator: boolean): ClickthroughResultsSchema {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'responseId': json['responseId'],
+        'results': ((json['results'] as Array<any>).map(ClickthroughResultsInnerFromJSON)),
+    };
+}
+
+export function ClickthroughResultsSchemaToJSON(json: any): ClickthroughResultsSchema {
+    return ClickthroughResultsSchemaToJSONTyped(json, false);
+}
+
+export function ClickthroughResultsSchemaToJSONTyped(value?: ClickthroughResultsSchema | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'responseId': value['responseId'],
+        'results': ((value['results'] as Array<any>).map(ClickthroughResultsInnerToJSON)),
+    };
+}
+

package/src/client/models/ClickthroughResultsSchema1.ts

@@ -0,0 +1,92 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * analytics.athoscommerce.net
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.2.48
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { ClickthroughResultsInner } from './ClickthroughResultsInner';
+import {
+    ClickthroughResultsInnerFromJSON,
+    ClickthroughResultsInnerFromJSONTyped,
+    ClickthroughResultsInnerToJSON,
+    ClickthroughResultsInnerToJSONTyped,
+} from './ClickthroughResultsInner';
+
+/**
+ * 
+ * @export
+ * @interface ClickthroughResultsSchema1
+ */
+export interface ClickthroughResultsSchema1 {
+    /**
+     * Tag of the personalized recommendation profile the shopper interacted with
+     * @type {string}
+     * @memberof ClickthroughResultsSchema1
+     */
+    tag: string;
+    /**
+     * Unique ID returned in each API response
+     * @type {string}
+     * @memberof ClickthroughResultsSchema1
+     */
+    responseId: string;
+    /**
+     * List of tracked result(s). Can be a result that is either a product or a banner.
+     * @type {Array<ClickthroughResultsInner>}
+     * @memberof ClickthroughResultsSchema1
+     */
+    results: Array<ClickthroughResultsInner>;
+}
+
+/**
+ * Check if a given object implements the ClickthroughResultsSchema1 interface.
+ */
+export function instanceOfClickthroughResultsSchema1(value: object): value is ClickthroughResultsSchema1 {
+    if (!('tag' in value) || value['tag'] === undefined) return false;
+    if (!('responseId' in value) || value['responseId'] === undefined) return false;
+    if (!('results' in value) || value['results'] === undefined) return false;
+    return true;
+}
+
+export function ClickthroughResultsSchema1FromJSON(json: any): ClickthroughResultsSchema1 {
+    return ClickthroughResultsSchema1FromJSONTyped(json, false);
+}
+
+export function ClickthroughResultsSchema1FromJSONTyped(json: any, ignoreDiscriminator: boolean): ClickthroughResultsSchema1 {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'tag': json['tag'],
+        'responseId': json['responseId'],
+        'results': ((json['results'] as Array<any>).map(ClickthroughResultsInnerFromJSON)),
+    };
+}
+
+export function ClickthroughResultsSchema1ToJSON(json: any): ClickthroughResultsSchema1 {
+    return ClickthroughResultsSchema1ToJSONTyped(json, false);
+}
+
+export function ClickthroughResultsSchema1ToJSONTyped(value?: ClickthroughResultsSchema1 | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'tag': value['tag'],
+        'responseId': value['responseId'],
+        'results': ((value['results'] as Array<any>).map(ClickthroughResultsInnerToJSON)),
+    };
+}
+

package/src/client/models/ClickthroughSchema.ts

@@ -0,0 +1,90 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * analytics.athoscommerce.net
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.2.48
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { Context } from './Context';
+import {
+    ContextFromJSON,
+    ContextFromJSONTyped,
+    ContextToJSON,
+    ContextToJSONTyped,
+} from './Context';
+import type { ClickthroughSchemaData } from './ClickthroughSchemaData';
+import {
+    ClickthroughSchemaDataFromJSON,
+    ClickthroughSchemaDataFromJSONTyped,
+    ClickthroughSchemaDataToJSON,
+    ClickthroughSchemaDataToJSONTyped,
+} from './ClickthroughSchemaData';
+
+/**
+ * 
+ * @export
+ * @interface ClickthroughSchema
+ */
+export interface ClickthroughSchema {
+    /**
+     * 
+     * @type {Context}
+     * @memberof ClickthroughSchema
+     */
+    context: Context;
+    /**
+     * 
+     * @type {ClickthroughSchemaData}
+     * @memberof ClickthroughSchema
+     */
+    data: ClickthroughSchemaData;
+}
+
+/**
+ * Check if a given object implements the ClickthroughSchema interface.
+ */
+export function instanceOfClickthroughSchema(value: object): value is ClickthroughSchema {
+    if (!('context' in value) || value['context'] === undefined) return false;
+    if (!('data' in value) || value['data'] === undefined) return false;
+    return true;
+}
+
+export function ClickthroughSchemaFromJSON(json: any): ClickthroughSchema {
+    return ClickthroughSchemaFromJSONTyped(json, false);
+}
+
+export function ClickthroughSchemaFromJSONTyped(json: any, ignoreDiscriminator: boolean): ClickthroughSchema {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'context': ContextFromJSON(json['context']),
+        'data': ClickthroughSchemaDataFromJSON(json['data']),
+    };
+}
+
+export function ClickthroughSchemaToJSON(json: any): ClickthroughSchema {
+    return ClickthroughSchemaToJSONTyped(json, false);
+}
+
+export function ClickthroughSchemaToJSONTyped(value?: ClickthroughSchema | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'context': ContextToJSON(value['context']),
+        'data': ClickthroughSchemaDataToJSON(value['data']),
+    };
+}
+

package/src/client/models/ClickthroughSchemaData.ts

@@ -0,0 +1,76 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * analytics.athoscommerce.net
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.2.48
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import type { ClickthroughBannersSchema } from './ClickthroughBannersSchema';
+import {
+    instanceOfClickthroughBannersSchema,
+    ClickthroughBannersSchemaFromJSON,
+    ClickthroughBannersSchemaFromJSONTyped,
+    ClickthroughBannersSchemaToJSON,
+} from './ClickthroughBannersSchema';
+import type { ClickthroughResultsSchema } from './ClickthroughResultsSchema';
+import {
+    instanceOfClickthroughResultsSchema,
+    ClickthroughResultsSchemaFromJSON,
+    ClickthroughResultsSchemaFromJSONTyped,
+    ClickthroughResultsSchemaToJSON,
+} from './ClickthroughResultsSchema';
+
+/**
+ * @type ClickthroughSchemaData
+ * Event details
+ * @export
+ */
+export type ClickthroughSchemaData = ClickthroughBannersSchema | ClickthroughResultsSchema;
+
+export function ClickthroughSchemaDataFromJSON(json: any): ClickthroughSchemaData {
+    return ClickthroughSchemaDataFromJSONTyped(json, false);
+}
+
+export function ClickthroughSchemaDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): ClickthroughSchemaData {
+    if (json == null) {
+        return json;
+    }
+    if (typeof json !== 'object') {
+        return json;
+    }
+    if (instanceOfClickthroughBannersSchema(json)) {
+        return ClickthroughBannersSchemaFromJSONTyped(json, true);
+    }
+    if (instanceOfClickthroughResultsSchema(json)) {
+        return ClickthroughResultsSchemaFromJSONTyped(json, true);
+    }
+    return {} as any;
+}
+
+export function ClickthroughSchemaDataToJSON(json: any): any {
+    return ClickthroughSchemaDataToJSONTyped(json, false);
+}
+
+export function ClickthroughSchemaDataToJSONTyped(value?: ClickthroughSchemaData | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+    if (typeof value !== 'object') {
+        return value;
+    }
+    if (instanceOfClickthroughBannersSchema(value)) {
+        return ClickthroughBannersSchemaToJSON(value as ClickthroughBannersSchema);
+    }
+    if (instanceOfClickthroughResultsSchema(value)) {
+        return ClickthroughResultsSchemaToJSON(value as ClickthroughResultsSchema);
+    }
+    return {};
+}
+

package/src/client/models/Context.ts

@@ -0,0 +1,174 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * analytics.athoscommerce.net
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.2.48
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { AttributionInner } from './AttributionInner';
+import {
+    AttributionInnerFromJSON,
+    AttributionInnerFromJSONTyped,
+    AttributionInnerToJSON,
+    AttributionInnerToJSONTyped,
+} from './AttributionInner';
+import type { Currency } from './Currency';
+import {
+    CurrencyFromJSON,
+    CurrencyFromJSONTyped,
+    CurrencyToJSON,
+    CurrencyToJSONTyped,
+} from './Currency';
+
+/**
+ * Contextual data about the event
+ * @export
+ * @interface Context
+ */
+export interface Context {
+    /**
+     * Shoppers IP address. Accepts IPv4 and IPv6 formats. Recommended this is passed for accuracy. If not, will attempt to default to the "x-forwarded-for" or the Remote Address.
+     * @type {string}
+     * @memberof Context
+     */
+    iP?: string;
+    /**
+     * Shoppers UserAgent. Recommended this is passed for accuracy. If not, will attempt to default to "user-agent" request header.
+     * @type {string}
+     * @memberof Context
+     */
+    userAgent?: string;
+    /**
+     * RFC3339 formatted timestamp represents time of event
+     * @type {string}
+     * @memberof Context
+     */
+    timestamp: string;
+    /**
+     * Current page `window.location.href` value
+     * @type {string}
+     * @memberof Context
+     */
+    pageUrl: string;
+    /**
+     * Unique identifier for the customer (usually a UUID)
+     * @type {string}
+     * @memberof Context
+     */
+    userId: string;
+    /**
+     * Unique identifier for the customer's current session - should expire after store visit (usually a UUID)
+     * @type {string}
+     * @memberof Context
+     */
+    sessionId: string;
+    /**
+     * Unique identifier that represents a unique page load. Used to tie multiple events made on a single page together.
+     * @type {string}
+     * @memberof Context
+     */
+    pageLoadId: string;
+    /**
+     * Unique identifier for the customer's product personalization - it is typically a user id or email and should be sent if the user is authenticated on the storefront. If the shopper has already logged in this is required.
+     * @type {string}
+     * @memberof Context
+     */
+    shopperId?: string;
+    /**
+     * Application identifier that initiated the event
+     * @type {string}
+     * @memberof Context
+     */
+    initiator: string;
+    /**
+     * Provides attribution details on product landing pages - it is currently only used for email recommendations
+     * @type {Array<AttributionInner>}
+     * @memberof Context
+     */
+    attribution?: Array<AttributionInner>;
+    /**
+     * 
+     * @type {Currency}
+     * @memberof Context
+     */
+    currency?: Currency;
+    /**
+     * Developer mode flag. If set to `true`, the event data will not populate in reporting
+     * @type {boolean}
+     * @memberof Context
+     */
+    dev?: boolean;
+}
+
+/**
+ * Check if a given object implements the Context interface.
+ */
+export function instanceOfContext(value: object): value is Context {
+    if (!('timestamp' in value) || value['timestamp'] === undefined) return false;
+    if (!('pageUrl' in value) || value['pageUrl'] === undefined) return false;
+    if (!('userId' in value) || value['userId'] === undefined) return false;
+    if (!('sessionId' in value) || value['sessionId'] === undefined) return false;
+    if (!('pageLoadId' in value) || value['pageLoadId'] === undefined) return false;
+    if (!('initiator' in value) || value['initiator'] === undefined) return false;
+    return true;
+}
+
+export function ContextFromJSON(json: any): Context {
+    return ContextFromJSONTyped(json, false);
+}
+
+export function ContextFromJSONTyped(json: any, ignoreDiscriminator: boolean): Context {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'iP': json['IP'] == null ? undefined : json['IP'],
+        'userAgent': json['userAgent'] == null ? undefined : json['userAgent'],
+        'timestamp': json['timestamp'],
+        'pageUrl': json['pageUrl'],
+        'userId': json['userId'],
+        'sessionId': json['sessionId'],
+        'pageLoadId': json['pageLoadId'],
+        'shopperId': json['shopperId'] == null ? undefined : json['shopperId'],
+        'initiator': json['initiator'],
+        'attribution': json['attribution'] == null ? undefined : ((json['attribution'] as Array<any>).map(AttributionInnerFromJSON)),
+        'currency': json['currency'] == null ? undefined : CurrencyFromJSON(json['currency']),
+        'dev': json['dev'] == null ? undefined : json['dev'],
+    };
+}
+
+export function ContextToJSON(json: any): Context {
+    return ContextToJSONTyped(json, false);
+}
+
+export function ContextToJSONTyped(value?: Context | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'IP': value['iP'],
+        'userAgent': value['userAgent'],
+        'timestamp': value['timestamp'],
+        'pageUrl': value['pageUrl'],
+        'userId': value['userId'],
+        'sessionId': value['sessionId'],
+        'pageLoadId': value['pageLoadId'],
+        'shopperId': value['shopperId'],
+        'initiator': value['initiator'],
+        'attribution': value['attribution'] == null ? undefined : ((value['attribution'] as Array<any>).map(AttributionInnerToJSON)),
+        'currency': CurrencyToJSON(value['currency']),
+        'dev': value['dev'],
+    };
+}
+

package/src/client/models/Currency.ts

@@ -0,0 +1,65 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * analytics.athoscommerce.net
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.2.48
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * Active currency type on the site
+ * @export
+ * @interface Currency
+ */
+export interface Currency {
+    /**
+     * currency code in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html#:~:text=The%20first%20two%20letters%20of,and%20the%20D%20for%20dollar.) format
+     * @type {string}
+     * @memberof Currency
+     */
+    code?: string;
+}
+
+/**
+ * Check if a given object implements the Currency interface.
+ */
+export function instanceOfCurrency(value: object): value is Currency {
+    return true;
+}
+
+export function CurrencyFromJSON(json: any): Currency {
+    return CurrencyFromJSONTyped(json, false);
+}
+
+export function CurrencyFromJSONTyped(json: any, ignoreDiscriminator: boolean): Currency {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'code': json['code'] == null ? undefined : json['code'],
+    };
+}
+
+export function CurrencyToJSON(json: any): Currency {
+    return CurrencyToJSONTyped(json, false);
+}
+
+export function CurrencyToJSONTyped(value?: Currency | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'code': value['code'],
+    };
+}
+