@athoscommerce/beacon 1.0.0

package/src/client/docs/Context.md

@@ -0,0 +1,57 @@
+
+# Context
+
+Contextual data about the 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 { Context } 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 Context
+
+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 Context
+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/Currency.md

@@ -0,0 +1,35 @@
+
+# Currency
+
+Active currency type on the site
+
+## Properties
+
+Name | Type
+------------ | -------------
+`code` | string
+
+## Example
+
+```typescript
+import type { Currency } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "code": null,
+} satisfies Currency
+
+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 Currency
+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/ErrorLogsApi.md

@@ -0,0 +1,239 @@
+# ErrorLogsApi
+
+All URIs are relative to *https://analytics.athoscommerce.net/beacon/v2*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**logPersonalization**](ErrorLogsApi.md#logpersonalization) | **POST** /{siteId}/log/personalization | personalization |
+| [**logShopifypixel**](ErrorLogsApi.md#logshopifypixel) | **POST** /{siteId}/log/shopifypixel | shopifypixel |
+| [**logSnap**](ErrorLogsApi.md#logsnap) | **POST** /{siteId}/log/snap | snap |
+
+
+
+## logPersonalization
+
+> InlineObject logPersonalization(siteId, personalizationLogSchema)
+
+personalization
+
+<i>/beacon/v2/{siteId}/log/personalization</i><br><br>Personalization error log events
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ErrorLogsApi,
+} from '';
+import type { LogPersonalizationRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new ErrorLogsApi();
+
+  const body = {
+    // string | Customer siteId found in the Athos Console or Athos Management Console
+    siteId: siteId_example,
+    // PersonalizationLogSchema | Personalization error log
+    personalizationLogSchema: ...,
+  } satisfies LogPersonalizationRequest;
+
+  try {
+    const data = await api.logPersonalization(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`] |
+| **personalizationLogSchema** | [PersonalizationLogSchema](PersonalizationLogSchema.md) | Personalization error log | |
+
+### 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)
+
+
+## logShopifypixel
+
+> InlineObject logShopifypixel(siteId, logSchema)
+
+shopifypixel
+
+<i>/beacon/v2/{siteId}/log/shopifypixel</i><br><br>Shopify Pixel Extension error log events
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ErrorLogsApi,
+} from '';
+import type { LogShopifypixelRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new ErrorLogsApi();
+
+  const body = {
+    // string | Customer siteId found in the Athos Console or Athos Management Console
+    siteId: siteId_example,
+    // LogSchema | Shopify Pixel extension error log
+    logSchema: ...,
+  } satisfies LogShopifypixelRequest;
+
+  try {
+    const data = await api.logShopifypixel(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`] |
+| **logSchema** | [LogSchema](LogSchema.md) | Shopify Pixel extension error log | |
+
+### 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)
+
+
+## logSnap
+
+> InlineObject logSnap(siteId, logSchema)
+
+snap
+
+<i>/beacon/v2/{siteId}/log/snap</i><br><br>Snap error log events
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ErrorLogsApi,
+} from '';
+import type { LogSnapRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new ErrorLogsApi();
+
+  const body = {
+    // string | Customer siteId found in the Athos Console or Athos Management Console
+    siteId: siteId_example,
+    // LogSchema | Snap error log
+    logSchema: ...,
+  } satisfies LogSnapRequest;
+
+  try {
+    const data = await api.logSnap(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`] |
+| **logSchema** | [LogSchema](LogSchema.md) | Snap error log | |
+
+### 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/ErrorResponseBody.md

@@ -0,0 +1,38 @@
+
+# ErrorResponseBody
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`success` | boolean
+`error` | string
+`messages` | Array<string>
+
+## Example
+
+```typescript
+import type { ErrorResponseBody } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "success": null,
+  "error": null,
+  "messages": null,
+} satisfies ErrorResponseBody
+
+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 ErrorResponseBody
+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/ImpressionSchema.md

@@ -0,0 +1,36 @@
+
+# ImpressionSchema
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`context` | [Context](Context.md)
+`data` | [ImpressionSchemaData](ImpressionSchemaData.md)
+
+## Example
+
+```typescript
+import type { ImpressionSchema } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "context": null,
+  "data": null,
+} satisfies ImpressionSchema
+
+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 ImpressionSchema
+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/ImpressionSchemaData.md

@@ -0,0 +1,39 @@
+
+# ImpressionSchemaData
+
+Event details
+
+## Properties
+
+Name | Type
+------------ | -------------
+`responseId` | string
+`results` | [Array<ResultsInner>](ResultsInner.md)
+`banners` | [Array<BannersInner>](BannersInner.md)
+
+## Example
+
+```typescript
+import type { ImpressionSchemaData } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "responseId": null,
+  "results": null,
+  "banners": null,
+} satisfies ImpressionSchemaData
+
+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 ImpressionSchemaData
+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/InlineObject.md

@@ -0,0 +1,34 @@
+
+# InlineObject
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`success` | boolean
+
+## Example
+
+```typescript
+import type { InlineObject } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "success": null,
+} satisfies InlineObject
+
+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 InlineObject
+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/InlineObject1.md

@@ -0,0 +1,40 @@
+
+# InlineObject1
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`success` | boolean
+`error` | string
+`messages` | Array<string>
+`data` | string
+
+## Example
+
+```typescript
+import type { InlineObject1 } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "success": null,
+  "error": null,
+  "messages": null,
+  "data": null,
+} satisfies InlineObject1
+
+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 InlineObject1
+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/LogSchema.md

@@ -0,0 +1,36 @@
+
+# LogSchema
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`context` | [Context](Context.md)
+`data` | [LogSchemaData](LogSchemaData.md)
+
+## Example
+
+```typescript
+import type { LogSchema } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "context": null,
+  "data": null,
+} satisfies LogSchema
+
+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 LogSchema
+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/LogSchemaData.md

@@ -0,0 +1,39 @@
+
+# LogSchemaData
+
+Log data about the event
+
+## Properties
+
+Name | Type
+------------ | -------------
+`message` | string
+`stack` | string
+`details` | object
+
+## Example
+
+```typescript
+import type { LogSchemaData } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "message": null,
+  "stack": null,
+  "details": null,
+} satisfies LogSchemaData
+
+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 LogSchemaData
+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)
+
+