Add docusaurus

docs/node-tracker/markdown/index.md

@@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md)
+
+## API Reference
+
+## Packages
+
+|  Package | Description |
+|  --- | --- |
+|  [@snowplow/node-tracker](./node-tracker.md) |  |
+

docs/node-tracker/markdown/node-tracker.adclickevent.advertiserid.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@snowplow/node-tracker](./node-tracker.md) &gt; [AdClickEvent](./node-tracker.adclickevent.md) &gt; [advertiserId](./node-tracker.adclickevent.advertiserid.md)
+
+## AdClickEvent.advertiserId property
+
+Identifier for the advertiser which the campaign belongs to
+
+<b>Signature:</b>
+
+```typescript
+advertiserId?: string;
+```

docs/node-tracker/markdown/node-tracker.adclickevent.bannerid.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@snowplow/node-tracker](./node-tracker.md) &gt; [AdClickEvent](./node-tracker.adclickevent.md) &gt; [bannerId](./node-tracker.adclickevent.bannerid.md)
+
+## AdClickEvent.bannerId property
+
+Identifier for the ad banner being displayed
+
+<b>Signature:</b>
+
+```typescript
+bannerId?: string;
+```

docs/node-tracker/markdown/node-tracker.adclickevent.campaignid.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@snowplow/node-tracker](./node-tracker.md) &gt; [AdClickEvent](./node-tracker.adclickevent.md) &gt; [campaignId](./node-tracker.adclickevent.campaignid.md)
+
+## AdClickEvent.campaignId property
+
+Identifier for the advertiser which the campaign belongs to
+
+<b>Signature:</b>
+
+```typescript
+campaignId?: string;
+```

docs/node-tracker/markdown/node-tracker.adclickevent.clickid.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@snowplow/node-tracker](./node-tracker.md) &gt; [AdClickEvent](./node-tracker.adclickevent.md) &gt; [clickId](./node-tracker.adclickevent.clickid.md)
+
+## AdClickEvent.clickId property
+
+Identifier for the particular click instance
+
+<b>Signature:</b>
+
+```typescript
+clickId?: string;
+```

docs/node-tracker/markdown/node-tracker.adclickevent.cost.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@snowplow/node-tracker](./node-tracker.md) &gt; [AdClickEvent](./node-tracker.adclickevent.md) &gt; [cost](./node-tracker.adclickevent.cost.md)
+
+## AdClickEvent.cost property
+
+Advertisement cost
+
+<b>Signature:</b>
+
+```typescript
+cost?: number;
+```

docs/node-tracker/markdown/node-tracker.adclickevent.costmodel.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@snowplow/node-tracker](./node-tracker.md) &gt; [AdClickEvent](./node-tracker.adclickevent.md) &gt; [costModel](./node-tracker.adclickevent.costmodel.md)
+
+## AdClickEvent.costModel property
+
+The cost model for the campaign
+
+<b>Signature:</b>
+
+```typescript
+costModel?: "cpa" | "cpc" | "cpm";
+```

docs/node-tracker/markdown/node-tracker.adclickevent.impressionid.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@snowplow/node-tracker](./node-tracker.md) &gt; [AdClickEvent](./node-tracker.adclickevent.md) &gt; [impressionId](./node-tracker.adclickevent.impressionid.md)
+
+## AdClickEvent.impressionId property
+
+Identifier for the particular impression instance
+
+<b>Signature:</b>
+
+```typescript
+impressionId?: string;
+```

docs/node-tracker/markdown/node-tracker.adclickevent.md

@@ -0,0 +1,32 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@snowplow/node-tracker](./node-tracker.md) &gt; [AdClickEvent](./node-tracker.adclickevent.md)
+
+## AdClickEvent interface
+
+An Ad Click Event Used to track an advertisement click
+
+<b>Signature:</b>
+
+```typescript
+interface AdClickEvent 
+```
+
+## Remarks
+
+If you provide the cost field, you must also provide one of 'cpa', 'cpc', and 'cpm' for the costModel field.
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [advertiserId?](./node-tracker.adclickevent.advertiserid.md) | string | <i>(Optional)</i> Identifier for the advertiser which the campaign belongs to |
+|  [bannerId?](./node-tracker.adclickevent.bannerid.md) | string | <i>(Optional)</i> Identifier for the ad banner being displayed |
+|  [campaignId?](./node-tracker.adclickevent.campaignid.md) | string | <i>(Optional)</i> Identifier for the advertiser which the campaign belongs to |
+|  [clickId?](./node-tracker.adclickevent.clickid.md) | string | <i>(Optional)</i> Identifier for the particular click instance |
+|  [cost?](./node-tracker.adclickevent.cost.md) | number | <i>(Optional)</i> Advertisement cost |
+|  [costModel?](./node-tracker.adclickevent.costmodel.md) | "cpa" \| "cpc" \| "cpm" | <i>(Optional)</i> The cost model for the campaign |
+|  [impressionId?](./node-tracker.adclickevent.impressionid.md) | string | <i>(Optional)</i> Identifier for the particular impression instance |
+|  [targetUrl](./node-tracker.adclickevent.targeturl.md) | string | The destination URL of the advertisement |
+|  [zoneId?](./node-tracker.adclickevent.zoneid.md) | string | <i>(Optional)</i> Identifier for the zone where the ad banner is located |
+

docs/node-tracker/markdown/node-tracker.adclickevent.targeturl.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@snowplow/node-tracker](./node-tracker.md) &gt; [AdClickEvent](./node-tracker.adclickevent.md) &gt; [targetUrl](./node-tracker.adclickevent.targeturl.md)
+
+## AdClickEvent.targetUrl property
+
+The destination URL of the advertisement
+
+<b>Signature:</b>
+
+```typescript
+targetUrl: string;
+```

docs/node-tracker/markdown/node-tracker.adclickevent.zoneid.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@snowplow/node-tracker](./node-tracker.md) &gt; [AdClickEvent](./node-tracker.adclickevent.md) &gt; [zoneId](./node-tracker.adclickevent.zoneid.md)
+
+## AdClickEvent.zoneId property
+
+Identifier for the zone where the ad banner is located
+
+<b>Signature:</b>
+
+```typescript
+zoneId?: string;
+```

docs/node-tracker/markdown/node-tracker.adconversionevent.action.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@snowplow/node-tracker](./node-tracker.md) &gt; [AdConversionEvent](./node-tracker.adconversionevent.md) &gt; [action](./node-tracker.adconversionevent.action.md)
+
+## AdConversionEvent.action property
+
+The type of user interaction e.g. 'purchase'
+
+<b>Signature:</b>
+
+```typescript
+action?: string;
+```

docs/node-tracker/markdown/node-tracker.adconversionevent.advertiserid.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@snowplow/node-tracker](./node-tracker.md) &gt; [AdConversionEvent](./node-tracker.adconversionevent.md) &gt; [advertiserId](./node-tracker.adconversionevent.advertiserid.md)
+
+## AdConversionEvent.advertiserId property
+
+Identifier for the advertiser which the campaign belongs to
+
+<b>Signature:</b>
+
+```typescript
+advertiserId?: string;
+```

docs/node-tracker/markdown/node-tracker.adconversionevent.campaignid.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@snowplow/node-tracker](./node-tracker.md) &gt; [AdConversionEvent](./node-tracker.adconversionevent.md) &gt; [campaignId](./node-tracker.adconversionevent.campaignid.md)
+
+## AdConversionEvent.campaignId property
+
+Identifier for the advertiser which the campaign belongs to
+
+<b>Signature:</b>
+
+```typescript
+campaignId?: string;
+```

docs/node-tracker/markdown/node-tracker.adconversionevent.category.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@snowplow/node-tracker](./node-tracker.md) &gt; [AdConversionEvent](./node-tracker.adconversionevent.md) &gt; [category](./node-tracker.adconversionevent.category.md)
+
+## AdConversionEvent.category property
+
+Conversion category
+
+<b>Signature:</b>
+
+```typescript
+category?: string;
+```

docs/node-tracker/markdown/node-tracker.adconversionevent.conversionid.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@snowplow/node-tracker](./node-tracker.md) &gt; [AdConversionEvent](./node-tracker.adconversionevent.md) &gt; [conversionId](./node-tracker.adconversionevent.conversionid.md)
+
+## AdConversionEvent.conversionId property
+
+Identifier for the particular conversion instance
+
+<b>Signature:</b>
+
+```typescript
+conversionId?: string;
+```

docs/node-tracker/markdown/node-tracker.adconversionevent.cost.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@snowplow/node-tracker](./node-tracker.md) &gt; [AdConversionEvent](./node-tracker.adconversionevent.md) &gt; [cost](./node-tracker.adconversionevent.cost.md)
+
+## AdConversionEvent.cost property
+
+Advertisement cost
+
+<b>Signature:</b>
+
+```typescript
+cost?: number;
+```

docs/node-tracker/markdown/node-tracker.adconversionevent.costmodel.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@snowplow/node-tracker](./node-tracker.md) &gt; [AdConversionEvent](./node-tracker.adconversionevent.md) &gt; [costModel](./node-tracker.adconversionevent.costmodel.md)
+
+## AdConversionEvent.costModel property
+
+The cost model for the campaign
+
+<b>Signature:</b>
+
+```typescript
+costModel?: "cpa" | "cpc" | "cpm";
+```

docs/node-tracker/markdown/node-tracker.adconversionevent.initialvalue.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@snowplow/node-tracker](./node-tracker.md) &gt; [AdConversionEvent](./node-tracker.adconversionevent.md) &gt; [initialValue](./node-tracker.adconversionevent.initialvalue.md)
+
+## AdConversionEvent.initialValue property
+
+How much the conversion is initially worth
+
+<b>Signature:</b>
+
+```typescript
+initialValue?: number;
+```

docs/node-tracker/markdown/node-tracker.adconversionevent.md

@@ -0,0 +1,32 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@snowplow/node-tracker](./node-tracker.md) &gt; [AdConversionEvent](./node-tracker.adconversionevent.md)
+
+## AdConversionEvent interface
+
+An Ad Conversion Event Used to track an advertisement click
+
+<b>Signature:</b>
+
+```typescript
+interface AdConversionEvent 
+```
+
+## Remarks
+
+If you provide the cost field, you must also provide one of 'cpa', 'cpc', and 'cpm' for the costModel field.
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [action?](./node-tracker.adconversionevent.action.md) | string | <i>(Optional)</i> The type of user interaction e.g. 'purchase' |
+|  [advertiserId?](./node-tracker.adconversionevent.advertiserid.md) | string | <i>(Optional)</i> Identifier for the advertiser which the campaign belongs to |
+|  [campaignId?](./node-tracker.adconversionevent.campaignid.md) | string | <i>(Optional)</i> Identifier for the advertiser which the campaign belongs to |
+|  [category?](./node-tracker.adconversionevent.category.md) | string | <i>(Optional)</i> Conversion category |
+|  [conversionId?](./node-tracker.adconversionevent.conversionid.md) | string | <i>(Optional)</i> Identifier for the particular conversion instance |
+|  [cost?](./node-tracker.adconversionevent.cost.md) | number | <i>(Optional)</i> Advertisement cost |
+|  [costModel?](./node-tracker.adconversionevent.costmodel.md) | "cpa" \| "cpc" \| "cpm" | <i>(Optional)</i> The cost model for the campaign |
+|  [initialValue?](./node-tracker.adconversionevent.initialvalue.md) | number | <i>(Optional)</i> How much the conversion is initially worth |
+|  [property?](./node-tracker.adconversionevent.property.md) | string | <i>(Optional)</i> Describes the object of the conversion |
+

docs/node-tracker/markdown/node-tracker.adconversionevent.property.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@snowplow/node-tracker](./node-tracker.md) &gt; [AdConversionEvent](./node-tracker.adconversionevent.md) &gt; [property](./node-tracker.adconversionevent.property.md)
+
+## AdConversionEvent.property property
+
+Describes the object of the conversion
+
+<b>Signature:</b>
+
+```typescript
+property?: string;
+```

docs/node-tracker/markdown/node-tracker.addtocartevent.category.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@snowplow/node-tracker](./node-tracker.md) &gt; [AddToCartEvent](./node-tracker.addtocartevent.md) &gt; [category](./node-tracker.addtocartevent.category.md)
+
+## AddToCartEvent.category property
+
+The category of the product
+
+<b>Signature:</b>
+
+```typescript
+category?: string;
+```

docs/node-tracker/markdown/node-tracker.addtocartevent.currency.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@snowplow/node-tracker](./node-tracker.md) &gt; [AddToCartEvent](./node-tracker.addtocartevent.md) &gt; [currency](./node-tracker.addtocartevent.currency.md)
+
+## AddToCartEvent.currency property
+
+The currency of the product
+
+<b>Signature:</b>
+
+```typescript
+currency?: string;
+```

docs/node-tracker/markdown/node-tracker.addtocartevent.md

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@snowplow/node-tracker](./node-tracker.md) &gt; [AddToCartEvent](./node-tracker.addtocartevent.md)
+
+## AddToCartEvent interface
+
+An Add To Cart Event For tracking users adding items from a cart on an ecommerce site.
+
+<b>Signature:</b>
+
+```typescript
+interface AddToCartEvent 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [category?](./node-tracker.addtocartevent.category.md) | string | <i>(Optional)</i> The category of the product |
+|  [currency?](./node-tracker.addtocartevent.currency.md) | string | <i>(Optional)</i> The currency of the product |
+|  [name?](./node-tracker.addtocartevent.name.md) | string | <i>(Optional)</i> The name of the product |
+|  [quantity](./node-tracker.addtocartevent.quantity.md) | number | The number added to the cart |
+|  [sku](./node-tracker.addtocartevent.sku.md) | string | A Product Stock Keeping Unit (SKU) |
+|  [unitPrice?](./node-tracker.addtocartevent.unitprice.md) | number | <i>(Optional)</i> The price of the product |
+

docs/node-tracker/markdown/node-tracker.addtocartevent.name.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@snowplow/node-tracker](./node-tracker.md) &gt; [AddToCartEvent](./node-tracker.addtocartevent.md) &gt; [name](./node-tracker.addtocartevent.name.md)
+
+## AddToCartEvent.name property
+
+The name of the product
+
+<b>Signature:</b>
+
+```typescript
+name?: string;
+```