@athoscommerce/beacon 1.0.0

package/src/client/apis/CategoryApi.ts

@@ -0,0 +1,264 @@
+/* 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 * as runtime from '../runtime';
+import type {
+  AddtocartSchema,
+  ClickthroughSchema,
+  ErrorResponseBody,
+  ImpressionSchema,
+  InlineObject,
+  InlineObject1,
+  RenderSchema,
+} from '../models/index';
+import {
+    AddtocartSchemaFromJSON,
+    AddtocartSchemaToJSON,
+    ClickthroughSchemaFromJSON,
+    ClickthroughSchemaToJSON,
+    ErrorResponseBodyFromJSON,
+    ErrorResponseBodyToJSON,
+    ImpressionSchemaFromJSON,
+    ImpressionSchemaToJSON,
+    InlineObjectFromJSON,
+    InlineObjectToJSON,
+    InlineObject1FromJSON,
+    InlineObject1ToJSON,
+    RenderSchemaFromJSON,
+    RenderSchemaToJSON,
+} from '../models/index';
+
+export interface CategoryAddtocartRequest {
+    siteId: string;
+    addtocartSchema: AddtocartSchema;
+}
+
+export interface CategoryClickthroughRequest {
+    siteId: string;
+    clickthroughSchema: ClickthroughSchema;
+}
+
+export interface CategoryImpressionRequest {
+    siteId: string;
+    impressionSchema: ImpressionSchema;
+}
+
+export interface CategoryRenderRequest {
+    siteId: string;
+    renderSchema: RenderSchema;
+}
+
+/**
+ * 
+ */
+export class CategoryApi extends runtime.BaseAPI {
+
+    /**
+     * <i>/beacon/v2/{siteId}/category/addtocart</i><br><br>Shopper lands on a category results page where Athos Commerce results are rendered, and adds a result to the cart via a `Quick Add to Cart` button. **If frontend `Quick Add to Cart` is not implemented, omit usage of this endpoint.**
+     * addtocart
+     */
+    async categoryAddtocartRaw(requestParameters: CategoryAddtocartRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InlineObject>> {
+        if (requestParameters['siteId'] == null) {
+            throw new runtime.RequiredError(
+                'siteId',
+                'Required parameter "siteId" was null or undefined when calling categoryAddtocart().'
+            );
+        }
+
+        if (requestParameters['addtocartSchema'] == null) {
+            throw new runtime.RequiredError(
+                'addtocartSchema',
+                'Required parameter "addtocartSchema" was null or undefined when calling categoryAddtocart().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'text/plain';
+
+
+        let urlPath = `/{siteId}/category/addtocart`;
+        urlPath = urlPath.replace(`{${"siteId"}}`, encodeURIComponent(String(requestParameters['siteId'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: AddtocartSchemaToJSON(requestParameters['addtocartSchema']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => InlineObjectFromJSON(jsonValue));
+    }
+
+    /**
+     * <i>/beacon/v2/{siteId}/category/addtocart</i><br><br>Shopper lands on a category results page where Athos Commerce results are rendered, and adds a result to the cart via a `Quick Add to Cart` button. **If frontend `Quick Add to Cart` is not implemented, omit usage of this endpoint.**
+     * addtocart
+     */
+    async categoryAddtocart(requestParameters: CategoryAddtocartRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InlineObject> {
+        const response = await this.categoryAddtocartRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * <i>/beacon/v2/{siteId}/category/clickthrough</i><br><br>Shopper lands on a category results page, clicks on a Athos Commerce result, and will be taken to the product detail page (PDP).
+     * clickthrough
+     */
+    async categoryClickthroughRaw(requestParameters: CategoryClickthroughRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InlineObject>> {
+        if (requestParameters['siteId'] == null) {
+            throw new runtime.RequiredError(
+                'siteId',
+                'Required parameter "siteId" was null or undefined when calling categoryClickthrough().'
+            );
+        }
+
+        if (requestParameters['clickthroughSchema'] == null) {
+            throw new runtime.RequiredError(
+                'clickthroughSchema',
+                'Required parameter "clickthroughSchema" was null or undefined when calling categoryClickthrough().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'text/plain';
+
+
+        let urlPath = `/{siteId}/category/clickthrough`;
+        urlPath = urlPath.replace(`{${"siteId"}}`, encodeURIComponent(String(requestParameters['siteId'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: ClickthroughSchemaToJSON(requestParameters['clickthroughSchema']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => InlineObjectFromJSON(jsonValue));
+    }
+
+    /**
+     * <i>/beacon/v2/{siteId}/category/clickthrough</i><br><br>Shopper lands on a category results page, clicks on a Athos Commerce result, and will be taken to the product detail page (PDP).
+     * clickthrough
+     */
+    async categoryClickthrough(requestParameters: CategoryClickthroughRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InlineObject> {
+        const response = await this.categoryClickthroughRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * <i>/beacon/v2/{siteId}/category/impression</i><br><br>Shopper lands on a category results page and Athos Commerce results receive an impression.
+     * impression
+     */
+    async categoryImpressionRaw(requestParameters: CategoryImpressionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InlineObject>> {
+        if (requestParameters['siteId'] == null) {
+            throw new runtime.RequiredError(
+                'siteId',
+                'Required parameter "siteId" was null or undefined when calling categoryImpression().'
+            );
+        }
+
+        if (requestParameters['impressionSchema'] == null) {
+            throw new runtime.RequiredError(
+                'impressionSchema',
+                'Required parameter "impressionSchema" was null or undefined when calling categoryImpression().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'text/plain';
+
+
+        let urlPath = `/{siteId}/category/impression`;
+        urlPath = urlPath.replace(`{${"siteId"}}`, encodeURIComponent(String(requestParameters['siteId'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: ImpressionSchemaToJSON(requestParameters['impressionSchema']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => InlineObjectFromJSON(jsonValue));
+    }
+
+    /**
+     * <i>/beacon/v2/{siteId}/category/impression</i><br><br>Shopper lands on a category results page and Athos Commerce results receive an impression.
+     * impression
+     */
+    async categoryImpression(requestParameters: CategoryImpressionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InlineObject> {
+        const response = await this.categoryImpressionRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * <i>/beacon/v2/{siteId}/category/render</i><br><br>Shopper lands on a category results page and Athos Commerce results are rendered.
+     * render
+     */
+    async categoryRenderRaw(requestParameters: CategoryRenderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InlineObject>> {
+        if (requestParameters['siteId'] == null) {
+            throw new runtime.RequiredError(
+                'siteId',
+                'Required parameter "siteId" was null or undefined when calling categoryRender().'
+            );
+        }
+
+        if (requestParameters['renderSchema'] == null) {
+            throw new runtime.RequiredError(
+                'renderSchema',
+                'Required parameter "renderSchema" was null or undefined when calling categoryRender().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'text/plain';
+
+
+        let urlPath = `/{siteId}/category/render`;
+        urlPath = urlPath.replace(`{${"siteId"}}`, encodeURIComponent(String(requestParameters['siteId'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: RenderSchemaToJSON(requestParameters['renderSchema']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => InlineObjectFromJSON(jsonValue));
+    }
+
+    /**
+     * <i>/beacon/v2/{siteId}/category/render</i><br><br>Shopper lands on a category results page and Athos Commerce results are rendered.
+     * render
+     */
+    async categoryRender(requestParameters: CategoryRenderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InlineObject> {
+        const response = await this.categoryRenderRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/client/apis/ErrorLogsApi.ts

@@ -0,0 +1,204 @@
+/* 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 * as runtime from '../runtime';
+import type {
+  ErrorResponseBody,
+  InlineObject,
+  InlineObject1,
+  LogSchema,
+  PersonalizationLogSchema,
+} from '../models/index';
+import {
+    ErrorResponseBodyFromJSON,
+    ErrorResponseBodyToJSON,
+    InlineObjectFromJSON,
+    InlineObjectToJSON,
+    InlineObject1FromJSON,
+    InlineObject1ToJSON,
+    LogSchemaFromJSON,
+    LogSchemaToJSON,
+    PersonalizationLogSchemaFromJSON,
+    PersonalizationLogSchemaToJSON,
+} from '../models/index';
+
+export interface LogPersonalizationRequest {
+    siteId: string;
+    personalizationLogSchema: PersonalizationLogSchema;
+}
+
+export interface LogShopifypixelRequest {
+    siteId: string;
+    logSchema: LogSchema;
+}
+
+export interface LogSnapRequest {
+    siteId: string;
+    logSchema: LogSchema;
+}
+
+/**
+ * 
+ */
+export class ErrorLogsApi extends runtime.BaseAPI {
+
+    /**
+     * <i>/beacon/v2/{siteId}/log/personalization</i><br><br>Personalization error log events
+     * personalization
+     */
+    async logPersonalizationRaw(requestParameters: LogPersonalizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InlineObject>> {
+        if (requestParameters['siteId'] == null) {
+            throw new runtime.RequiredError(
+                'siteId',
+                'Required parameter "siteId" was null or undefined when calling logPersonalization().'
+            );
+        }
+
+        if (requestParameters['personalizationLogSchema'] == null) {
+            throw new runtime.RequiredError(
+                'personalizationLogSchema',
+                'Required parameter "personalizationLogSchema" was null or undefined when calling logPersonalization().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'text/plain';
+
+
+        let urlPath = `/{siteId}/log/personalization`;
+        urlPath = urlPath.replace(`{${"siteId"}}`, encodeURIComponent(String(requestParameters['siteId'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PersonalizationLogSchemaToJSON(requestParameters['personalizationLogSchema']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => InlineObjectFromJSON(jsonValue));
+    }
+
+    /**
+     * <i>/beacon/v2/{siteId}/log/personalization</i><br><br>Personalization error log events
+     * personalization
+     */
+    async logPersonalization(requestParameters: LogPersonalizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InlineObject> {
+        const response = await this.logPersonalizationRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * <i>/beacon/v2/{siteId}/log/shopifypixel</i><br><br>Shopify Pixel Extension error log events
+     * shopifypixel
+     */
+    async logShopifypixelRaw(requestParameters: LogShopifypixelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InlineObject>> {
+        if (requestParameters['siteId'] == null) {
+            throw new runtime.RequiredError(
+                'siteId',
+                'Required parameter "siteId" was null or undefined when calling logShopifypixel().'
+            );
+        }
+
+        if (requestParameters['logSchema'] == null) {
+            throw new runtime.RequiredError(
+                'logSchema',
+                'Required parameter "logSchema" was null or undefined when calling logShopifypixel().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'text/plain';
+
+
+        let urlPath = `/{siteId}/log/shopifypixel`;
+        urlPath = urlPath.replace(`{${"siteId"}}`, encodeURIComponent(String(requestParameters['siteId'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: LogSchemaToJSON(requestParameters['logSchema']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => InlineObjectFromJSON(jsonValue));
+    }
+
+    /**
+     * <i>/beacon/v2/{siteId}/log/shopifypixel</i><br><br>Shopify Pixel Extension error log events
+     * shopifypixel
+     */
+    async logShopifypixel(requestParameters: LogShopifypixelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InlineObject> {
+        const response = await this.logShopifypixelRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * <i>/beacon/v2/{siteId}/log/snap</i><br><br>Snap error log events
+     * snap
+     */
+    async logSnapRaw(requestParameters: LogSnapRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InlineObject>> {
+        if (requestParameters['siteId'] == null) {
+            throw new runtime.RequiredError(
+                'siteId',
+                'Required parameter "siteId" was null or undefined when calling logSnap().'
+            );
+        }
+
+        if (requestParameters['logSchema'] == null) {
+            throw new runtime.RequiredError(
+                'logSchema',
+                'Required parameter "logSchema" was null or undefined when calling logSnap().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'text/plain';
+
+
+        let urlPath = `/{siteId}/log/snap`;
+        urlPath = urlPath.replace(`{${"siteId"}}`, encodeURIComponent(String(requestParameters['siteId'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: LogSchemaToJSON(requestParameters['logSchema']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => InlineObjectFromJSON(jsonValue));
+    }
+
+    /**
+     * <i>/beacon/v2/{siteId}/log/snap</i><br><br>Snap error log events
+     * snap
+     */
+    async logSnap(requestParameters: LogSnapRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InlineObject> {
+        const response = await this.logSnapRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}