@athoscommerce/beacon 1.0.0

package/src/client/models/ResultProduct.ts

@@ -0,0 +1,102 @@
+/* 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 { ResultProductType } from './ResultProductType';
+import {
+    ResultProductTypeFromJSON,
+    ResultProductTypeFromJSONTyped,
+    ResultProductTypeToJSON,
+    ResultProductTypeToJSONTyped,
+} from './ResultProductType';
+
+/**
+ * Describes a tracked result.
+ * @export
+ * @interface ResultProduct
+ */
+export interface ResultProduct {
+    /**
+     * 
+     * @type {ResultProductType}
+     * @memberof ResultProduct
+     */
+    type: ResultProductType;
+    /**
+     * Unique product identifier of the parent product interacted with
+     * @type {string}
+     * @memberof ResultProduct
+     */
+    parentId: string;
+    /**
+     * Unique product identifier of the product interacted with
+     * @type {string}
+     * @memberof ResultProduct
+     */
+    uid: string;
+    /**
+     * SKU of the product interacted with
+     * @type {string}
+     * @memberof ResultProduct
+     */
+    sku?: string;
+}
+
+
+
+/**
+ * Check if a given object implements the ResultProduct interface.
+ */
+export function instanceOfResultProduct(value: object): value is ResultProduct {
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('parentId' in value) || value['parentId'] === undefined) return false;
+    if (!('uid' in value) || value['uid'] === undefined) return false;
+    return true;
+}
+
+export function ResultProductFromJSON(json: any): ResultProduct {
+    return ResultProductFromJSONTyped(json, false);
+}
+
+export function ResultProductFromJSONTyped(json: any, ignoreDiscriminator: boolean): ResultProduct {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'type': ResultProductTypeFromJSON(json['type']),
+        'parentId': json['parentId'],
+        'uid': json['uid'],
+        'sku': json['sku'] == null ? undefined : json['sku'],
+    };
+}
+
+export function ResultProductToJSON(json: any): ResultProduct {
+    return ResultProductToJSONTyped(json, false);
+}
+
+export function ResultProductToJSONTyped(value?: ResultProduct | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'type': ResultProductTypeToJSON(value['type']),
+        'parentId': value['parentId'],
+        'uid': value['uid'],
+        'sku': value['sku'],
+    };
+}
+

package/src/client/models/ResultProductType.ts

@@ -0,0 +1,53 @@
+/* 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.
+ */
+
+
+/**
+ * Defines the type of item tracked.
+ * @export
+ */
+export const ResultProductType = {
+    Product: 'product',
+    Banner: 'banner'
+} as const;
+export type ResultProductType = typeof ResultProductType[keyof typeof ResultProductType];
+
+
+export function instanceOfResultProductType(value: any): boolean {
+    for (const key in ResultProductType) {
+        if (Object.prototype.hasOwnProperty.call(ResultProductType, key)) {
+            if (ResultProductType[key as keyof typeof ResultProductType] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function ResultProductTypeFromJSON(json: any): ResultProductType {
+    return ResultProductTypeFromJSONTyped(json, false);
+}
+
+export function ResultProductTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): ResultProductType {
+    return json as ResultProductType;
+}
+
+export function ResultProductTypeToJSON(value?: ResultProductType | null): any {
+    return value as any;
+}
+
+export function ResultProductTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): ResultProductType {
+    return value as ResultProductType;
+}
+

package/src/client/models/ResultResultBanner.ts

@@ -0,0 +1,85 @@
+/* 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 { ResultProductType } from './ResultProductType';
+import {
+    ResultProductTypeFromJSON,
+    ResultProductTypeFromJSONTyped,
+    ResultProductTypeToJSON,
+    ResultProductTypeToJSONTyped,
+} from './ResultProductType';
+
+/**
+ * Describes a tracked inline banner.
+ * @export
+ * @interface ResultResultBanner
+ */
+export interface ResultResultBanner {
+    /**
+     * 
+     * @type {ResultProductType}
+     * @memberof ResultResultBanner
+     */
+    type: ResultProductType;
+    /**
+     * Unique product identifier of the product interacted with
+     * @type {string}
+     * @memberof ResultResultBanner
+     */
+    uid: string;
+}
+
+
+
+/**
+ * Check if a given object implements the ResultResultBanner interface.
+ */
+export function instanceOfResultResultBanner(value: object): value is ResultResultBanner {
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('uid' in value) || value['uid'] === undefined) return false;
+    return true;
+}
+
+export function ResultResultBannerFromJSON(json: any): ResultResultBanner {
+    return ResultResultBannerFromJSONTyped(json, false);
+}
+
+export function ResultResultBannerFromJSONTyped(json: any, ignoreDiscriminator: boolean): ResultResultBanner {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'type': ResultProductTypeFromJSON(json['type']),
+        'uid': json['uid'],
+    };
+}
+
+export function ResultResultBannerToJSON(json: any): ResultResultBanner {
+    return ResultResultBannerToJSONTyped(json, false);
+}
+
+export function ResultResultBannerToJSONTyped(value?: ResultResultBanner | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'type': ResultProductTypeToJSON(value['type']),
+        'uid': value['uid'],
+    };
+}
+

package/src/client/models/ResultsInner.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 ResultsInner
+ * 
+ * @export
+ */
+export type ResultsInner = ResultProduct | ResultResultBanner;
+
+export function ResultsInnerFromJSON(json: any): ResultsInner {
+    return ResultsInnerFromJSONTyped(json, false);
+}
+
+export function ResultsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): ResultsInner {
+    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 ResultsInnerToJSON(json: any): any {
+    return ResultsInnerToJSONTyped(json, false);
+}
+
+export function ResultsInnerToJSONTyped(value?: ResultsInner | 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/ShopperContext.ts

@@ -0,0 +1,175 @@
+/* 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 shopper event
+ * @export
+ * @interface ShopperContext
+ */
+export interface ShopperContext {
+    /**
+     * 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 ShopperContext
+     */
+    iP?: string;
+    /**
+     * Shoppers UserAgent. Recommended this is passed for accuracy. If not, will attempt to default to "user-agent" request header.
+     * @type {string}
+     * @memberof ShopperContext
+     */
+    userAgent?: string;
+    /**
+     * RFC3339 formatted timestamp represents time of event
+     * @type {string}
+     * @memberof ShopperContext
+     */
+    timestamp: string;
+    /**
+     * Current page `window.location.href` value
+     * @type {string}
+     * @memberof ShopperContext
+     */
+    pageUrl: string;
+    /**
+     * Unique identifier for the customer (usually a UUID)
+     * @type {string}
+     * @memberof ShopperContext
+     */
+    userId: string;
+    /**
+     * Unique identifier for the customer's current session - should expire after store visit (usually a UUID)
+     * @type {string}
+     * @memberof ShopperContext
+     */
+    sessionId: string;
+    /**
+     * Unique identifier that represents a unique page load. Used to tie multiple events made on a single page together.
+     * @type {string}
+     * @memberof ShopperContext
+     */
+    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 ShopperContext
+     */
+    shopperId: string;
+    /**
+     * Application identifier that initiated the event
+     * @type {string}
+     * @memberof ShopperContext
+     */
+    initiator: string;
+    /**
+     * Provides attribution details on product landing pages - it is currently only used for email recommendations
+     * @type {Array<AttributionInner>}
+     * @memberof ShopperContext
+     */
+    attribution?: Array<AttributionInner>;
+    /**
+     * 
+     * @type {Currency}
+     * @memberof ShopperContext
+     */
+    currency?: Currency;
+    /**
+     * Developer mode flag. If set to `true`, the event data will not populate in reporting
+     * @type {boolean}
+     * @memberof ShopperContext
+     */
+    dev?: boolean;
+}
+
+/**
+ * Check if a given object implements the ShopperContext interface.
+ */
+export function instanceOfShopperContext(value: object): value is ShopperContext {
+    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 (!('shopperId' in value) || value['shopperId'] === undefined) return false;
+    if (!('initiator' in value) || value['initiator'] === undefined) return false;
+    return true;
+}
+
+export function ShopperContextFromJSON(json: any): ShopperContext {
+    return ShopperContextFromJSONTyped(json, false);
+}
+
+export function ShopperContextFromJSONTyped(json: any, ignoreDiscriminator: boolean): ShopperContext {
+    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'],
+        '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 ShopperContextToJSON(json: any): ShopperContext {
+    return ShopperContextToJSONTyped(json, false);
+}
+
+export function ShopperContextToJSONTyped(value?: ShopperContext | 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/ShopperLoginSchema.ts

@@ -0,0 +1,74 @@
+/* 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 { ShopperContext } from './ShopperContext';
+import {
+    ShopperContextFromJSON,
+    ShopperContextFromJSONTyped,
+    ShopperContextToJSON,
+    ShopperContextToJSONTyped,
+} from './ShopperContext';
+
+/**
+ * 
+ * @export
+ * @interface ShopperLoginSchema
+ */
+export interface ShopperLoginSchema {
+    /**
+     * 
+     * @type {ShopperContext}
+     * @memberof ShopperLoginSchema
+     */
+    context: ShopperContext;
+}
+
+/**
+ * Check if a given object implements the ShopperLoginSchema interface.
+ */
+export function instanceOfShopperLoginSchema(value: object): value is ShopperLoginSchema {
+    if (!('context' in value) || value['context'] === undefined) return false;
+    return true;
+}
+
+export function ShopperLoginSchemaFromJSON(json: any): ShopperLoginSchema {
+    return ShopperLoginSchemaFromJSONTyped(json, false);
+}
+
+export function ShopperLoginSchemaFromJSONTyped(json: any, ignoreDiscriminator: boolean): ShopperLoginSchema {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'context': ShopperContextFromJSON(json['context']),
+    };
+}
+
+export function ShopperLoginSchemaToJSON(json: any): ShopperLoginSchema {
+    return ShopperLoginSchemaToJSONTyped(json, false);
+}
+
+export function ShopperLoginSchemaToJSONTyped(value?: ShopperLoginSchema | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'context': ShopperContextToJSON(value['context']),
+    };
+}
+

package/src/client/models/ValidationErrorWithDataField.ts

@@ -0,0 +1,89 @@
+/* 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';
+/**
+ * 
+ * @export
+ * @interface ValidationErrorWithDataField
+ */
+export interface ValidationErrorWithDataField {
+    /**
+     * Data sent but not received due to an error
+     * @type {boolean}
+     * @memberof ValidationErrorWithDataField
+     */
+    success?: boolean;
+    /**
+     * Cause of error
+     * @type {string}
+     * @memberof ValidationErrorWithDataField
+     */
+    error?: string;
+    /**
+     * Cause of failure(s)
+     * @type {Array<string>}
+     * @memberof ValidationErrorWithDataField
+     */
+    messages?: Array<string>;
+    /**
+     * Data sent where an error is identified
+     * @type {string}
+     * @memberof ValidationErrorWithDataField
+     */
+    data?: string;
+}
+
+/**
+ * Check if a given object implements the ValidationErrorWithDataField interface.
+ */
+export function instanceOfValidationErrorWithDataField(value: object): value is ValidationErrorWithDataField {
+    return true;
+}
+
+export function ValidationErrorWithDataFieldFromJSON(json: any): ValidationErrorWithDataField {
+    return ValidationErrorWithDataFieldFromJSONTyped(json, false);
+}
+
+export function ValidationErrorWithDataFieldFromJSONTyped(json: any, ignoreDiscriminator: boolean): ValidationErrorWithDataField {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'success': json['success'] == null ? undefined : json['success'],
+        'error': json['error'] == null ? undefined : json['error'],
+        'messages': json['messages'] == null ? undefined : json['messages'],
+        'data': json['data'] == null ? undefined : json['data'],
+    };
+}
+
+export function ValidationErrorWithDataFieldToJSON(json: any): ValidationErrorWithDataField {
+    return ValidationErrorWithDataFieldToJSONTyped(json, false);
+}
+
+export function ValidationErrorWithDataFieldToJSONTyped(value?: ValidationErrorWithDataField | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'success': value['success'],
+        'error': value['error'],
+        'messages': value['messages'],
+        'data': value['data'],
+    };
+}
+