@athoscommerce/beacon 1.0.0

package/src/client/docs/AddtocartSchema.md

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

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

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

@@ -0,0 +1,393 @@
+# AutocompleteApi
+
+All URIs are relative to *https://analytics.athoscommerce.net/beacon/v2*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**autocompleteAddtocart**](AutocompleteApi.md#autocompleteaddtocart) | **POST** /{siteId}/autocomplete/addtocart | addtocart |
+| [**autocompleteClickthrough**](AutocompleteApi.md#autocompleteclickthrough) | **POST** /{siteId}/autocomplete/clickthrough | clickthrough |
+| [**autocompleteImpression**](AutocompleteApi.md#autocompleteimpression) | **POST** /{siteId}/autocomplete/impression | impression |
+| [**autocompleteRedirect**](AutocompleteApi.md#autocompleteredirect) | **POST** /{siteId}/autocomplete/redirect | redirect |
+| [**autocompleteRender**](AutocompleteApi.md#autocompleterender) | **POST** /{siteId}/autocomplete/render | render |
+
+
+
+## autocompleteAddtocart
+
+> InlineObject autocompleteAddtocart(siteId, addtocartSchema)
+
+addtocart
+
+<i>/beacon/v2/{siteId}/autocomplete/addtocart</i><br><br>Shopper adds a Athos Commerce autocomplete result to the cart via a `Quick Add to Cart` button in the Autocomplete Module. **If frontend `Quick Add to Cart` is not implemented, omit usage of this endpoint.**
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AutocompleteApi,
+} from '';
+import type { AutocompleteAddtocartRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new AutocompleteApi();
+
+  const body = {
+    // string | Customer siteId found in the Athos Console or Athos Management Console
+    siteId: siteId_example,
+    // AddtocartSchema | Results payload
+    addtocartSchema: ...,
+  } satisfies AutocompleteAddtocartRequest;
+
+  try {
+    const data = await api.autocompleteAddtocart(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)
+
+
+## autocompleteClickthrough
+
+> InlineObject autocompleteClickthrough(siteId, clickthroughSchema)
+
+clickthrough
+
+<i>/beacon/v2/{siteId}/autocomplete/clickthrough</i><br><br>Shopper clicks on a Athos Commerce autocomplete search result rendered in the Autocomplete Module, and is taken to the product detail page (PDP).
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AutocompleteApi,
+} from '';
+import type { AutocompleteClickthroughRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new AutocompleteApi();
+
+  const body = {
+    // string | Customer siteId found in the Athos Console or Athos Management Console
+    siteId: siteId_example,
+    // ClickthroughSchema | Results payload
+    clickthroughSchema: ...,
+  } satisfies AutocompleteClickthroughRequest;
+
+  try {
+    const data = await api.autocompleteClickthrough(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)
+
+
+## autocompleteImpression
+
+> InlineObject autocompleteImpression(siteId, impressionSchema)
+
+impression
+
+<i>/beacon/v2/{siteId}/autocomplete/impression</i><br><br>Shopper views the rendered Athos Commerce autocomplete results in the Autocomplete Module.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AutocompleteApi,
+} from '';
+import type { AutocompleteImpressionRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new AutocompleteApi();
+
+  const body = {
+    // string | Customer siteId found in the Athos Console or Athos Management Console
+    siteId: siteId_example,
+    // ImpressionSchema | Results payload
+    impressionSchema: ...,
+  } satisfies AutocompleteImpressionRequest;
+
+  try {
+    const data = await api.autocompleteImpression(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)
+
+
+## autocompleteRedirect
+
+> InlineObject autocompleteRedirect(siteId, redirectSchema)
+
+redirect
+
+<i>/beacon/v2/{siteId}/autocomplete/redirect</i><br><br>Shopper types in the searchbar and an Autocomplete Module with Athos Commerce autocomplete search results are rendered, but a redirect URL is returned in the Autocomplete API response and the shopper is redirected to the returned redirect URL.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AutocompleteApi,
+} from '';
+import type { AutocompleteRedirectRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new AutocompleteApi();
+
+  const body = {
+    // string | Customer siteId found in the Athos Console or Athos Management Console
+    siteId: siteId_example,
+    // RedirectSchema | Results payload
+    redirectSchema: ...,
+  } satisfies AutocompleteRedirectRequest;
+
+  try {
+    const data = await api.autocompleteRedirect(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)
+
+
+## autocompleteRender
+
+> InlineObject autocompleteRender(siteId, renderSchema)
+
+render
+
+<i>/beacon/v2/{siteId}/autocomplete/render</i><br><br>Shopper types in the searchbar and an Autocomplete Module with Athos Commerce autocomplete search results are rendered.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AutocompleteApi,
+} from '';
+import type { AutocompleteRenderRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new AutocompleteApi();
+
+  const body = {
+    // string | Customer siteId found in the Athos Console or Athos Management Console
+    siteId: siteId_example,
+    // RenderSchema | Results payload
+    renderSchema: ...,
+  } satisfies AutocompleteRenderRequest;
+
+  try {
+    const data = await api.autocompleteRender(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/BannersInner.md

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

@@ -0,0 +1,162 @@
+# CartApi
+
+All URIs are relative to *https://analytics.athoscommerce.net/beacon/v2*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**cartAdd**](CartApi.md#cartadd) | **POST** /{siteId}/cart/add | add |
+| [**cartRemove**](CartApi.md#cartremove) | **POST** /{siteId}/cart/remove | remove |
+
+
+
+## cartAdd
+
+> InlineObject cartAdd(siteId, cartSchema)
+
+add
+
+<i>/beacon/v2/{siteId}/cart/add</i><br><br>Shopper adds additional item quantities to an item in the cart via the cart page or a slideout cart.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CartApi,
+} from '';
+import type { CartAddRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new CartApi();
+
+  const body = {
+    // string | Customer siteId found in the Athos Console or Athos Management Console
+    siteId: siteId_example,
+    // CartSchema | Cart update payload
+    cartSchema: ...,
+  } satisfies CartAddRequest;
+
+  try {
+    const data = await api.cartAdd(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`] |
+| **cartSchema** | [CartSchema](CartSchema.md) | Cart update 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)
+
+
+## cartRemove
+
+> InlineObject cartRemove(siteId, cartSchema)
+
+remove
+
+<i>/beacon/v2/{siteId}/cart/remove</i><br><br>Shopper removes an item or reduces an items quantity in the cart via the cart page or a slideout cart.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CartApi,
+} from '';
+import type { CartRemoveRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new CartApi();
+
+  const body = {
+    // string | Customer siteId found in the Athos Console or Athos Management Console
+    siteId: siteId_example,
+    // CartSchema | Cart update payload
+    cartSchema: ...,
+  } satisfies CartRemoveRequest;
+
+  try {
+    const data = await api.cartRemove(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`] |
+| **cartSchema** | [CartSchema](CartSchema.md) | Cart update 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)
+