@athoscommerce/beacon 1.0.0

package/src/client/docs/PersonalizationLogSchemaData.md

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

@@ -0,0 +1,43 @@
+
+# Product
+
+Product details
+
+## Properties
+
+Name | Type
+------------ | -------------
+`parentId` | string
+`uid` | string
+`sku` | string
+`qty` | number
+`price` | number
+
+## Example
+
+```typescript
+import type { Product } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "parentId": null,
+  "uid": null,
+  "sku": null,
+  "qty": null,
+  "price": null,
+} satisfies Product
+
+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 Product
+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/ProductApi.md

@@ -0,0 +1,85 @@
+# ProductApi
+
+All URIs are relative to *https://analytics.athoscommerce.net/beacon/v2*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**productPageview**](ProductApi.md#productpageview) | **POST** /{siteId}/product/pageview | pageview |
+
+
+
+## productPageview
+
+> InlineObject productPageview(siteId, productPageviewSchema)
+
+pageview
+
+<i>/beacon/v2/{siteId}/product/pageview</i><br><br>Shopper has navigated to a product detail page (PDP).
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ProductApi,
+} from '';
+import type { ProductPageviewRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new ProductApi();
+
+  const body = {
+    // string | Customer siteId found in the Athos Console or Athos Management Console
+    siteId: siteId_example,
+    // ProductPageviewSchema | Product page view payload
+    productPageviewSchema: ...,
+  } satisfies ProductPageviewRequest;
+
+  try {
+    const data = await api.productPageview(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`] |
+| **productPageviewSchema** | [ProductPageviewSchema](ProductPageviewSchema.md) | Product page view 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/ProductPageviewSchema.md

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

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

@@ -0,0 +1,39 @@
+
+# ProductPageviewSchemaDataResult
+
+Describes a tracked Athos Commerce result.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`parentId` | string
+`uid` | string
+`sku` | string
+
+## Example
+
+```typescript
+import type { ProductPageviewSchemaDataResult } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "parentId": null,
+  "uid": null,
+  "sku": null,
+} satisfies ProductPageviewSchemaDataResult
+
+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 ProductPageviewSchemaDataResult
+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/RecommendationsAddtocartSchema.md

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

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

@@ -0,0 +1,316 @@
+# RecommendationsApi
+
+All URIs are relative to *https://analytics.athoscommerce.net/beacon/v2*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**recommendationsAddtocart**](RecommendationsApi.md#recommendationsaddtocart) | **POST** /{siteId}/recommendations/addtocart | addtocart |
+| [**recommendationsClickthrough**](RecommendationsApi.md#recommendationsclickthrough) | **POST** /{siteId}/recommendations/clickthrough | clickthrough |
+| [**recommendationsImpression**](RecommendationsApi.md#recommendationsimpression) | **POST** /{siteId}/recommendations/impression | impression |
+| [**recommendationsRender**](RecommendationsApi.md#recommendationsrender) | **POST** /{siteId}/recommendations/render | render |
+
+
+
+## recommendationsAddtocart
+
+> InlineObject recommendationsAddtocart(siteId, recommendationsAddtocartSchema)
+
+addtocart
+
+<i>/beacon/v2/{siteId}/recommendations/addtocart</i><br><br>Shopper adds a Athos Commerce personalized recommendation result to the cart via a `Quick Add to Cart` button in the rendered product card. **If frontend `Quick Add to Cart` is not implemented, omit usage of this endpoint.**
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RecommendationsApi,
+} from '';
+import type { RecommendationsAddtocartRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new RecommendationsApi();
+
+  const body = {
+    // string | Customer siteId found in the Athos Console or Athos Management Console
+    siteId: siteId_example,
+    // RecommendationsAddtocartSchema | Recommendations payload
+    recommendationsAddtocartSchema: ...,
+  } satisfies RecommendationsAddtocartRequest;
+
+  try {
+    const data = await api.recommendationsAddtocart(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`] |
+| **recommendationsAddtocartSchema** | [RecommendationsAddtocartSchema](RecommendationsAddtocartSchema.md) | 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)
+
+
+## recommendationsClickthrough
+
+> InlineObject recommendationsClickthrough(siteId, recommendationsClickthroughSchema)
+
+clickthrough
+
+<i>/beacon/v2/{siteId}/recommendations/clickthrough</i><br><br>Shopper clicks on a rendered Athos Commerce personalized recommended result, and is taken to the product detail page (PDP).
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RecommendationsApi,
+} from '';
+import type { RecommendationsClickthroughRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new RecommendationsApi();
+
+  const body = {
+    // string | Customer siteId found in the Athos Console or Athos Management Console
+    siteId: siteId_example,
+    // RecommendationsClickthroughSchema | Recommendations payload
+    recommendationsClickthroughSchema: ...,
+  } satisfies RecommendationsClickthroughRequest;
+
+  try {
+    const data = await api.recommendationsClickthrough(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`] |
+| **recommendationsClickthroughSchema** | [RecommendationsClickthroughSchema](RecommendationsClickthroughSchema.md) | 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)
+
+
+## recommendationsImpression
+
+> InlineObject recommendationsImpression(siteId, recommendationsImpressionSchema)
+
+impression
+
+<i>/beacon/v2/{siteId}/recommendations/impression</i><br><br>Shopper scrolls into view rendered Athos Commerce personalized recommended results. Results sent ***must*** only be results in the shoppers view at the time of the event.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RecommendationsApi,
+} from '';
+import type { RecommendationsImpressionRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new RecommendationsApi();
+
+  const body = {
+    // string | Customer siteId found in the Athos Console or Athos Management Console
+    siteId: siteId_example,
+    // RecommendationsImpressionSchema | Recommendations payload
+    recommendationsImpressionSchema: ...,
+  } satisfies RecommendationsImpressionRequest;
+
+  try {
+    const data = await api.recommendationsImpression(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`] |
+| **recommendationsImpressionSchema** | [RecommendationsImpressionSchema](RecommendationsImpressionSchema.md) | 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)
+
+
+## recommendationsRender
+
+> InlineObject recommendationsRender(siteId, recommendationsRenderSchema)
+
+render
+
+<i>/beacon/v2/{siteId}/recommendations/render</i><br><br>Shopper navigates to a page where Athos Commerce personalized recommendations are requested from the [Personalized Recommendations API endpoint](https://docs.searchspring.com/reference/get-recommendations) and rendered on the page.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RecommendationsApi,
+} from '';
+import type { RecommendationsRenderRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new RecommendationsApi();
+
+  const body = {
+    // string | Customer siteId found in the Athos Console or Athos Management Console
+    siteId: siteId_example,
+    // RecommendationsRenderSchema | Recommendations payload
+    recommendationsRenderSchema: ...,
+  } satisfies RecommendationsRenderRequest;
+
+  try {
+    const data = await api.recommendationsRender(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`] |
+| **recommendationsRenderSchema** | [RecommendationsRenderSchema](RecommendationsRenderSchema.md) | 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)
+