@athoscommerce/beacon 1.0.0

package/src/client/docs/SearchApi.md

@@ -0,0 +1,393 @@
+# SearchApi
+
+All URIs are relative to *https://analytics.athoscommerce.net/beacon/v2*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**searchAddtocart**](SearchApi.md#searchaddtocart) | **POST** /{siteId}/search/addtocart | addtocart |
+| [**searchClickthrough**](SearchApi.md#searchclickthrough) | **POST** /{siteId}/search/clickthrough | clickthrough |
+| [**searchImpression**](SearchApi.md#searchimpression) | **POST** /{siteId}/search/impression | impression |
+| [**searchRedirect**](SearchApi.md#searchredirect) | **POST** /{siteId}/search/redirect | redirect |
+| [**searchRender**](SearchApi.md#searchrender) | **POST** /{siteId}/search/render | render |
+
+
+
+## searchAddtocart
+
+> InlineObject searchAddtocart(siteId, addtocartSchema)
+
+addtocart
+
+<i>/beacon/v2/{siteId}/search/addtocart</i><br><br>This event should be triggered when a shopper lands on a search results page where Athos Commerce search 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.**
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SearchApi,
+} from '';
+import type { SearchAddtocartRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new SearchApi();
+
+  const body = {
+    // string | Customer siteId found in the Athos Console or Athos Management Console
+    siteId: siteId_example,
+    // AddtocartSchema | Results payload
+    addtocartSchema: ...,
+  } satisfies SearchAddtocartRequest;
+
+  try {
+    const data = await api.searchAddtocart(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **siteId** | `string` | Customer siteId found in the Athos Console or Athos Management Console | [Defaults to `undefined`] |
+| **addtocartSchema** | [AddtocartSchema](AddtocartSchema.md) | Results payload | |
+
+### Return type
+
+[**InlineObject**](InlineObject.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `text/plain`, `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  -  |
+| **400** | Bad request |  -  |
+| **404** | Invalid path |  -  |
+| **405** | Invalid request method |  -  |
+| **413** | Payload too large |  -  |
+| **415** | Unsupported media type |  -  |
+| **500** | Internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## searchClickthrough
+
+> InlineObject searchClickthrough(siteId, clickthroughSchema)
+
+clickthrough
+
+<i>/beacon/v2/{siteId}/search/clickthrough</i><br><br>This event should be triggered when a shopper lands on a search results page, clicks on a Athos Commerce search result, and will be taken to the product detail page (PDP).
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SearchApi,
+} from '';
+import type { SearchClickthroughRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new SearchApi();
+
+  const body = {
+    // string | Customer siteId found in the Athos Console or Athos Management Console
+    siteId: siteId_example,
+    // ClickthroughSchema | Results payload
+    clickthroughSchema: ...,
+  } satisfies SearchClickthroughRequest;
+
+  try {
+    const data = await api.searchClickthrough(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **siteId** | `string` | Customer siteId found in the Athos Console or Athos Management Console | [Defaults to `undefined`] |
+| **clickthroughSchema** | [ClickthroughSchema](ClickthroughSchema.md) | Results payload | |
+
+### Return type
+
+[**InlineObject**](InlineObject.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `text/plain`, `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  -  |
+| **400** | Bad request |  -  |
+| **404** | Invalid path |  -  |
+| **405** | Invalid request method |  -  |
+| **413** | Payload too large |  -  |
+| **415** | Unsupported media type |  -  |
+| **500** | Internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## searchImpression
+
+> InlineObject searchImpression(siteId, impressionSchema)
+
+impression
+
+<i>/beacon/v2/{siteId}/search/impression</i><br><br>This event should be triggered when a shopper lands on a search results page and Athos Commerce search results receive an impression.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SearchApi,
+} from '';
+import type { SearchImpressionRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new SearchApi();
+
+  const body = {
+    // string | Customer siteId found in the Athos Console or Athos Management Console
+    siteId: siteId_example,
+    // ImpressionSchema | Results payload
+    impressionSchema: ...,
+  } satisfies SearchImpressionRequest;
+
+  try {
+    const data = await api.searchImpression(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **siteId** | `string` | Customer siteId found in the Athos Console or Athos Management Console | [Defaults to `undefined`] |
+| **impressionSchema** | [ImpressionSchema](ImpressionSchema.md) | Results payload | |
+
+### Return type
+
+[**InlineObject**](InlineObject.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `text/plain`, `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  -  |
+| **400** | Bad request |  -  |
+| **404** | Invalid path |  -  |
+| **405** | Invalid request method |  -  |
+| **413** | Payload too large |  -  |
+| **415** | Unsupported media type |  -  |
+| **500** | Internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## searchRedirect
+
+> InlineObject searchRedirect(siteId, redirectSchema)
+
+redirect
+
+<i>/beacon/v2/{siteId}/search/redirect</i><br><br>This event should be triggered after a shopper lands on a search results page where Athos Commerce search results are rendered, but a redirect URL is returned in the Search API response and the shopper is redirected to the returned redirect URL.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SearchApi,
+} from '';
+import type { SearchRedirectRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new SearchApi();
+
+  const body = {
+    // string | Customer siteId found in the Athos Console or Athos Management Console
+    siteId: siteId_example,
+    // RedirectSchema | Results payload
+    redirectSchema: ...,
+  } satisfies SearchRedirectRequest;
+
+  try {
+    const data = await api.searchRedirect(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **siteId** | `string` | Customer siteId found in the Athos Console or Athos Management Console | [Defaults to `undefined`] |
+| **redirectSchema** | [RedirectSchema](RedirectSchema.md) | Results payload | |
+
+### Return type
+
+[**InlineObject**](InlineObject.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `text/plain`, `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  -  |
+| **400** | Bad request |  -  |
+| **404** | Invalid path |  -  |
+| **405** | Invalid request method |  -  |
+| **413** | Payload too large |  -  |
+| **415** | Unsupported media type |  -  |
+| **500** | Internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## searchRender
+
+> InlineObject searchRender(siteId, renderSchema)
+
+render
+
+<i>/beacon/v2/{siteId}/search/render</i><br><br>This event should be triggered when a shopper lands on a search results page and Athos Commerce search results are rendered.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SearchApi,
+} from '';
+import type { SearchRenderRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new SearchApi();
+
+  const body = {
+    // string | Customer siteId found in the Athos Console or Athos Management Console
+    siteId: siteId_example,
+    // RenderSchema | Results payload
+    renderSchema: ...,
+  } satisfies SearchRenderRequest;
+
+  try {
+    const data = await api.searchRender(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **siteId** | `string` | Customer siteId found in the Athos Console or Athos Management Console | [Defaults to `undefined`] |
+| **renderSchema** | [RenderSchema](RenderSchema.md) | Results payload | |
+
+### Return type
+
+[**InlineObject**](InlineObject.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `text/plain`, `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  -  |
+| **400** | Bad request |  -  |
+| **404** | Invalid path |  -  |
+| **405** | Invalid request method |  -  |
+| **413** | Payload too large |  -  |
+| **415** | Unsupported media type |  -  |
+| **500** | Internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/src/client/docs/ShopperApi.md

@@ -0,0 +1,85 @@
+# ShopperApi
+
+All URIs are relative to *https://analytics.athoscommerce.net/beacon/v2*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**login**](ShopperApi.md#login) | **POST** /{siteId}/shopper/login | login |
+
+
+
+## login
+
+> InlineObject login(siteId, shopperLoginSchema)
+
+login
+
+<i>/beacon/v2/{siteId}/shopper/login</i><br><br>Shopper successfully logs into their account.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ShopperApi,
+} from '';
+import type { LoginRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new ShopperApi();
+
+  const body = {
+    // string | Customer siteId found in the Athos Console or Athos Management Console
+    siteId: siteId_example,
+    // ShopperLoginSchema | Results payload
+    shopperLoginSchema: ...,
+  } satisfies LoginRequest;
+
+  try {
+    const data = await api.login(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **siteId** | `string` | Customer siteId found in the Athos Console or Athos Management Console | [Defaults to `undefined`] |
+| **shopperLoginSchema** | [ShopperLoginSchema](ShopperLoginSchema.md) | Results payload | |
+
+### Return type
+
+[**InlineObject**](InlineObject.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `text/plain`, `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  -  |
+| **400** | Bad request |  -  |
+| **404** | Invalid path |  -  |
+| **405** | Invalid request method |  -  |
+| **413** | Payload too large |  -  |
+| **415** | Unsupported media type |  -  |
+| **500** | Internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/src/client/docs/ShopperContext.md

@@ -0,0 +1,57 @@
+
+# ShopperContext
+
+Contextual data about the shopper event
+
+## Properties
+
+Name | Type
+------------ | -------------
+`iP` | string
+`userAgent` | string
+`timestamp` | string
+`pageUrl` | string
+`userId` | string
+`sessionId` | string
+`pageLoadId` | string
+`shopperId` | string
+`initiator` | string
+`attribution` | [Array<AttributionInner>](AttributionInner.md)
+`currency` | [Currency](Currency.md)
+`dev` | boolean
+
+## Example
+
+```typescript
+import type { ShopperContext } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "iP": null,
+  "userAgent": null,
+  "timestamp": null,
+  "pageUrl": null,
+  "userId": null,
+  "sessionId": null,
+  "pageLoadId": null,
+  "shopperId": null,
+  "initiator": null,
+  "attribution": null,
+  "currency": null,
+  "dev": null,
+} satisfies ShopperContext
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ShopperContext
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/src/client/docs/ShopperLoginSchema.md

@@ -0,0 +1,34 @@
+
+# ShopperLoginSchema
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`context` | [ShopperContext](ShopperContext.md)
+
+## Example
+
+```typescript
+import type { ShopperLoginSchema } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "context": null,
+} satisfies ShopperLoginSchema
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ShopperLoginSchema
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/src/client/docs/ValidationErrorWithDataField.md

@@ -0,0 +1,40 @@
+
+# ValidationErrorWithDataField
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`success` | boolean
+`error` | string
+`messages` | Array<string>
+`data` | string
+
+## Example
+
+```typescript
+import type { ValidationErrorWithDataField } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "success": null,
+  "error": null,
+  "messages": null,
+  "data": null,
+} satisfies ValidationErrorWithDataField
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ValidationErrorWithDataField
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/src/client/index.ts

@@ -0,0 +1,5 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './runtime';
+export * from './apis/index';
+export * from './models/index';

package/src/client/models/AddtocartSchema.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 { AddtocartSchemaData } from './AddtocartSchemaData';
+import {
+    AddtocartSchemaDataFromJSON,
+    AddtocartSchemaDataFromJSONTyped,
+    AddtocartSchemaDataToJSON,
+    AddtocartSchemaDataToJSONTyped,
+} from './AddtocartSchemaData';
+
+/**
+ * 
+ * @export
+ * @interface AddtocartSchema
+ */
+export interface AddtocartSchema {
+    /**
+     * 
+     * @type {Context}
+     * @memberof AddtocartSchema
+     */
+    context: Context;
+    /**
+     * 
+     * @type {AddtocartSchemaData}
+     * @memberof AddtocartSchema
+     */
+    data: AddtocartSchemaData;
+}
+
+/**
+ * Check if a given object implements the AddtocartSchema interface.
+ */
+export function instanceOfAddtocartSchema(value: object): value is AddtocartSchema {
+    if (!('context' in value) || value['context'] === undefined) return false;
+    if (!('data' in value) || value['data'] === undefined) return false;
+    return true;
+}
+
+export function AddtocartSchemaFromJSON(json: any): AddtocartSchema {
+    return AddtocartSchemaFromJSONTyped(json, false);
+}
+
+export function AddtocartSchemaFromJSONTyped(json: any, ignoreDiscriminator: boolean): AddtocartSchema {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'context': ContextFromJSON(json['context']),
+        'data': AddtocartSchemaDataFromJSON(json['data']),
+    };
+}
+
+export function AddtocartSchemaToJSON(json: any): AddtocartSchema {
+    return AddtocartSchemaToJSONTyped(json, false);
+}
+
+export function AddtocartSchemaToJSONTyped(value?: AddtocartSchema | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'context': ContextToJSON(value['context']),
+        'data': AddtocartSchemaDataToJSON(value['data']),
+    };
+}
+