@athoscommerce/beacon 1.0.0

package/src/client/docs/MessagingRecommendationsApi.md

@@ -0,0 +1,316 @@
+# MessagingRecommendationsApi
+
+All URIs are relative to *https://analytics.athoscommerce.net/beacon/v2*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**messagingEmailClickthrough**](MessagingRecommendationsApi.md#messagingemailclickthrough) | **POST** /{siteId}/email/clickthrough | email/clickthrough |
+| [**messagingEmailRender**](MessagingRecommendationsApi.md#messagingemailrender) | **POST** /{siteId}/email/render | email/render |
+| [**messagingSmsClickthrough**](MessagingRecommendationsApi.md#messagingsmsclickthrough) | **POST** /{siteId}/sms/clickthrough | sms/clickthrough |
+| [**messagingSmsRender**](MessagingRecommendationsApi.md#messagingsmsrender) | **POST** /{siteId}/sms/render | sms/render |
+
+
+
+## messagingEmailClickthrough
+
+> InlineObject messagingEmailClickthrough(siteId, messagingSchema)
+
+email/clickthrough
+
+<i>/beacon/v2/{siteId}/messaging/email/clickthrough</i><br><br>This event tracks when a shopper clicks through a messaging recommendation section in an email and is navigated to the website.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MessagingRecommendationsApi,
+} from '';
+import type { MessagingEmailClickthroughRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new MessagingRecommendationsApi();
+
+  const body = {
+    // string | Customer siteId found in the Athos Console or Athos Management Console
+    siteId: siteId_example,
+    // MessagingSchema | Messaging recommendations payload
+    messagingSchema: ...,
+  } satisfies MessagingEmailClickthroughRequest;
+
+  try {
+    const data = await api.messagingEmailClickthrough(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`] |
+| **messagingSchema** | [MessagingSchema](MessagingSchema.md) | Messaging recommendations 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)
+
+
+## messagingEmailRender
+
+> InlineObject messagingEmailRender(siteId, messagingSchema)
+
+email/render
+
+<i>/beacon/v2/{siteId}/messaging/email/render</i><br><br>This event tracks the rendering of a messaging recommendation section in an email.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MessagingRecommendationsApi,
+} from '';
+import type { MessagingEmailRenderRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new MessagingRecommendationsApi();
+
+  const body = {
+    // string | Customer siteId found in the Athos Console or Athos Management Console
+    siteId: siteId_example,
+    // MessagingSchema | Messaging recommendations payload
+    messagingSchema: ...,
+  } satisfies MessagingEmailRenderRequest;
+
+  try {
+    const data = await api.messagingEmailRender(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`] |
+| **messagingSchema** | [MessagingSchema](MessagingSchema.md) | Messaging recommendations 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)
+
+
+## messagingSmsClickthrough
+
+> InlineObject messagingSmsClickthrough(siteId, messagingSchema)
+
+sms/clickthrough
+
+<i>/beacon/v2/{siteId}/messaging/sms/clickthrough</i><br><br>This event tracks when a shopper clicks through a SMS recommendation section in an SMS text and is navigated to the website.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MessagingRecommendationsApi,
+} from '';
+import type { MessagingSmsClickthroughRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new MessagingRecommendationsApi();
+
+  const body = {
+    // string | Customer siteId found in the Athos Console or Athos Management Console
+    siteId: siteId_example,
+    // MessagingSchema | Messaging recommendations payload
+    messagingSchema: ...,
+  } satisfies MessagingSmsClickthroughRequest;
+
+  try {
+    const data = await api.messagingSmsClickthrough(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`] |
+| **messagingSchema** | [MessagingSchema](MessagingSchema.md) | Messaging recommendations 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)
+
+
+## messagingSmsRender
+
+> InlineObject messagingSmsRender(siteId, messagingSchema)
+
+sms/render
+
+<i>/beacon/v2/{siteId}/messaging/sms/render</i><br><br>This event tracks the rendering of an SMS recommendation section in an SMS text.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MessagingRecommendationsApi,
+} from '';
+import type { MessagingSmsRenderRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new MessagingRecommendationsApi();
+
+  const body = {
+    // string | Customer siteId found in the Athos Console or Athos Management Console
+    siteId: siteId_example,
+    // MessagingSchema | Messaging recommendations payload
+    messagingSchema: ...,
+  } satisfies MessagingSmsRenderRequest;
+
+  try {
+    const data = await api.messagingSmsRender(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`] |
+| **messagingSchema** | [MessagingSchema](MessagingSchema.md) | Messaging recommendations 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/MessagingSchema.md

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

@@ -0,0 +1,39 @@
+
+# MessagingSchemaContext
+
+Contextual data about the event
+
+## Properties
+
+Name | Type
+------------ | -------------
+`userId` | string
+`timestamp` | string
+`dev` | boolean
+
+## Example
+
+```typescript
+import type { MessagingSchemaContext } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "userId": null,
+  "timestamp": null,
+  "dev": null,
+} satisfies MessagingSchemaContext
+
+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 MessagingSchemaContext
+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/MessagingSchemaData.md

@@ -0,0 +1,37 @@
+
+# MessagingSchemaData
+
+Event details
+
+## Properties
+
+Name | Type
+------------ | -------------
+`uid` | string
+`tag` | string
+
+## Example
+
+```typescript
+import type { MessagingSchemaData } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "uid": null,
+  "tag": null,
+} satisfies MessagingSchemaData
+
+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 MessagingSchemaData
+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/OrderApi.md

@@ -0,0 +1,85 @@
+# OrderApi
+
+All URIs are relative to *https://analytics.athoscommerce.net/beacon/v2*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**orderTransaction**](OrderApi.md#ordertransaction) | **POST** /{siteId}/order/transaction | order transaction |
+
+
+
+## orderTransaction
+
+> InlineObject orderTransaction(siteId, orderTransactionSchema)
+
+order transaction
+
+<i>/beacon/v2/{siteId}/order/transaction</i><br><br>Shopper has completed an order transaction. Tracks order contents.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  OrderApi,
+} from '';
+import type { OrderTransactionRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new OrderApi();
+
+  const body = {
+    // string | Customer siteId found in the Athos Console or Athos Management Console
+    siteId: siteId_example,
+    // OrderTransactionSchema | Order transaction payload
+    orderTransactionSchema: ...,
+  } satisfies OrderTransactionRequest;
+
+  try {
+    const data = await api.orderTransaction(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`] |
+| **orderTransactionSchema** | [OrderTransactionSchema](OrderTransactionSchema.md) | Order transaction 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/OrderTransactionSchema.md

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

@@ -0,0 +1,49 @@
+
+# OrderTransactionSchemaData
+
+Event details
+
+## Properties
+
+Name | Type
+------------ | -------------
+`orderId` | string
+`transactionTotal` | number
+`total` | number
+`vat` | number
+`city` | string
+`state` | string
+`country` | string
+`results` | [Array<Product>](Product.md)
+
+## Example
+
+```typescript
+import type { OrderTransactionSchemaData } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "orderId": null,
+  "transactionTotal": null,
+  "total": null,
+  "vat": null,
+  "city": null,
+  "state": null,
+  "country": null,
+  "results": null,
+} satisfies OrderTransactionSchemaData
+
+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 OrderTransactionSchemaData
+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/PersonalizationLogContext.md

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

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