@athoscommerce/beacon 1.0.0

package/src/client/docs/CartSchema.md

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

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

@@ -0,0 +1,316 @@
+# CategoryApi
+
+All URIs are relative to *https://analytics.athoscommerce.net/beacon/v2*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**categoryAddtocart**](CategoryApi.md#categoryaddtocart) | **POST** /{siteId}/category/addtocart | addtocart |
+| [**categoryClickthrough**](CategoryApi.md#categoryclickthrough) | **POST** /{siteId}/category/clickthrough | clickthrough |
+| [**categoryImpression**](CategoryApi.md#categoryimpression) | **POST** /{siteId}/category/impression | impression |
+| [**categoryRender**](CategoryApi.md#categoryrender) | **POST** /{siteId}/category/render | render |
+
+
+
+## categoryAddtocart
+
+> InlineObject categoryAddtocart(siteId, addtocartSchema)
+
+addtocart
+
+<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.**
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CategoryApi,
+} from '';
+import type { CategoryAddtocartRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new CategoryApi();
+
+  const body = {
+    // string | Customer siteId found in the Athos Console or Athos Management Console
+    siteId: siteId_example,
+    // AddtocartSchema | Results payload
+    addtocartSchema: ...,
+  } satisfies CategoryAddtocartRequest;
+
+  try {
+    const data = await api.categoryAddtocart(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)
+
+
+## categoryClickthrough
+
+> InlineObject categoryClickthrough(siteId, clickthroughSchema)
+
+clickthrough
+
+<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).
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CategoryApi,
+} from '';
+import type { CategoryClickthroughRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new CategoryApi();
+
+  const body = {
+    // string | Customer siteId found in the Athos Console or Athos Management Console
+    siteId: siteId_example,
+    // ClickthroughSchema | Results payload
+    clickthroughSchema: ...,
+  } satisfies CategoryClickthroughRequest;
+
+  try {
+    const data = await api.categoryClickthrough(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)
+
+
+## categoryImpression
+
+> InlineObject categoryImpression(siteId, impressionSchema)
+
+impression
+
+<i>/beacon/v2/{siteId}/category/impression</i><br><br>Shopper lands on a category results page and Athos Commerce results receive an impression.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CategoryApi,
+} from '';
+import type { CategoryImpressionRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new CategoryApi();
+
+  const body = {
+    // string | Customer siteId found in the Athos Console or Athos Management Console
+    siteId: siteId_example,
+    // ImpressionSchema | Results payload
+    impressionSchema: ...,
+  } satisfies CategoryImpressionRequest;
+
+  try {
+    const data = await api.categoryImpression(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)
+
+
+## categoryRender
+
+> InlineObject categoryRender(siteId, renderSchema)
+
+render
+
+<i>/beacon/v2/{siteId}/category/render</i><br><br>Shopper lands on a category results page and Athos Commerce results are rendered.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CategoryApi,
+} from '';
+import type { CategoryRenderRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new CategoryApi();
+
+  const body = {
+    // string | Customer siteId found in the Athos Console or Athos Management Console
+    siteId: siteId_example,
+    // RenderSchema | Results payload
+    renderSchema: ...,
+  } satisfies CategoryRenderRequest;
+
+  try {
+    const data = await api.categoryRender(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/ClickthroughBannersInner.md

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

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

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

@@ -0,0 +1,40 @@
+
+# ClickthroughResultsInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | [ResultProductType](ResultProductType.md)
+`parentId` | string
+`uid` | string
+`sku` | string
+
+## Example
+
+```typescript
+import type { ClickthroughResultsInner } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "parentId": null,
+  "uid": null,
+  "sku": null,
+} satisfies ClickthroughResultsInner
+
+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 ClickthroughResultsInner
+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/ClickthroughResultsSchema.md

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

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

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

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