@seeka-labs/sdk-apps-server 2.0.21-alpha.0 → 2.2.1

package/dist/types/{src/api → api}/services/index.d.ts

@@ -27,9 +27,6 @@ export declare class IdentityServiceProxy extends ApiServiceProxyBase {
     protected baseUrl: string;
     protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
     constructor(configuration: SeekaAppConfig, baseUrl?: string, instance?: AxiosInstance);
-    /**
-     * Merge identity
-     */
     merge(payload: PersonIdentificationRequest, cancelToken?: CancelToken): Promise<ApiResponseDtoOfPersonIdentificationResolutionResponse>;
     protected processMerge(response: AxiosResponse): Promise<ApiResponseDtoOfPersonIdentificationResolutionResponse>;
 }
@@ -38,9 +35,6 @@ export declare class IngestServiceProxy extends ApiServiceProxyBase {
     protected baseUrl: string;
     protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
     constructor(configuration: SeekaAppConfig, baseUrl?: string, instance?: AxiosInstance);
-    /**
-     * Track activity
-     */
     batch(payload: DataIngestBatchHttpRequest, cancelToken?: CancelToken): Promise<void>;
     protected processBatch(response: AxiosResponse): Promise<void>;
 }
@@ -89,132 +83,84 @@ export interface HelpAction {
     helpActionTitle?: string;
 }
 export interface PersonIdentificationRequest {
-    /** Collection of identifiers used to calculate the identity graph. */
     id: PersonIdentifiers;
-    /** Source of the identification request. */
     src: TrackingEventSource;
 }
 export interface PersonIdentifiersBase {
-    /** Browser user agent */
     ua?: string[];
-    /** IP Address */
     ip?: string[];
-    /** Seeka Person ID - Identity graph ID */
     seekaPId?: string;
-    /** Seeka Browser ID */
     seekaBId?: string[];
-    /** Email address */
     email?: string[];
-    /** Gender */
     gender?: string[];
-    /** Phone number. Recommended to provide in E.164 format. */
     phone?: string[];
-    /** External ID */
     eid?: string[];
-    /** First name */
     firstName?: string[];
-    /** Last name / surname */
     lastName?: string[];
-    /** Shipping, mailing or residential address */
     address?: PlaceAddress[];
-    /** Date of birth */
     dob?: Date[];
-    /** Shopify identifiers */
     shopify?: ShopifyPersonIdentifiers;
-    /** WooCommerce identifiers */
     wooCommerce?: WooCommercePersonIdentifiers;
-    /** BigCommerce identifiers */
     bigCommerce?: BigCommercePersonIdentifiers;
-    /** Magento identifiers */
     magento?: MagentoPersonIdentifiers;
-    /** Klaviyo identifiers scoped by Klaviyo account ID */
     klaviyo?: ScopedIdentifiersOfKlaviyoPersonIdentifiersDtoAndString;
-    /** Arbitrary traits */
     traits?: {
         [key: string]: any;
     };
 }
 export interface PersonIdentifiers extends PersonIdentifiersBase {
-    /** Facebook identifiers */
     facebook?: FacebookPersonIdentifiers;
-    /** Snapchat identifiers */
     snapchat?: SnapchatPersonIdentifiers;
-    /** TikTok identifiers */
     tiktok?: TikTokPersonIdentifiers;
-    /** Google identifiers */
     google?: GooglePersonIdentifiers;
-    /** Pinterest identifiers */
     pinterest?: PinterestPersonIdentifiers;
-    /** Marketing, analytics and other third-party opt in/consent information */
     consent?: PersonConsentInfo;
 }
 export interface BrandScopedFacebookPersonIdentifiers {
-    /** Facebook user login ID */
     login?: string[];
-    /** Facebook click ID */
     fbc?: string[];
-    /** Facebook lead ID */
     lead?: string[];
 }
 export interface FacebookPersonIdentifiers extends BrandScopedFacebookPersonIdentifiers {
-    /** Facebook pixel / browser ID */
     fbp?: string[];
 }
 export interface BrandScopedSnapchatPersonIdentifiers {
-    /** Snapchat click ID */
     sccid?: string[];
 }
 export interface SnapchatPersonIdentifiers extends BrandScopedSnapchatPersonIdentifiers {
-    /** Snapchat pixel / browser ID */
     scid?: string[];
 }
 export interface BrandScopedTikTokPersonIdentifiers {
-    /** TikTok click ID */
     ttclid?: string[];
-    /** TikTok lead ID */
     lead?: string[];
 }
 export interface TikTokPersonIdentifiers extends BrandScopedTikTokPersonIdentifiers {
-    /** TikTok pixel / browser ID */
     ttp?: string[];
 }
 export interface BrandScopedGooglePersonIdentifiers {
-    /** Google click ID */
     gclid?: string[];
-    /** Google Braid ID */
     gbraid?: string[];
-    /** Google Web Braid ID */
     wbraid?: string[];
 }
 export interface GooglePersonIdentifiers extends BrandScopedGooglePersonIdentifiers {
-    /** Google user client ID */
     userClientId?: string[];
 }
 export interface BrandScopedPinterestPersonIdentifiers {
-    /** Pinterest click ID / epik ID */
     epik?: string[];
 }
 export interface PinterestPersonIdentifiers extends BrandScopedPinterestPersonIdentifiers {
 }
 export interface PersonConsentInfo {
-    /** Grant for sending data to 3rd party analytics and marketing platforms. */
     analytics?: ConsentInfo;
-    /** Grant for marketing via re-marketing campaigns, EDMs etc.  */
     marketing?: MarketingConsentInfo;
-    /** Grant for enrolling and participating in loyalty programs.  */
     loyalty?: ConsentInfo;
     privacy?: PrivacyState;
 }
 export interface ConsentInfo {
-    /** Type of consent */
     type?: PrivacyConsentType;
-    /** When the consent was granted. */
     consentGrantedAt?: Date | undefined;
-    /** The name of the source that provided the grant information. Set to the source platform like Shopify, Wordpress or your custom integration client name. */
     consentGrantedSourceName?: string;
-    /** When the consent was not granted. */
     consentNotGrantedAt?: Date | undefined;
-    /** The name of the source that provided the grant information. Set to the source platform like Shopify, Wordpress or your custom integration client name. */
     consentNotGrantedSourceName?: string;
 }
 export declare enum PrivacyConsentType {
@@ -230,8 +176,6 @@ export interface MarketingConsentInfo {
     sms?: ConsentInfo;
 }
 export interface PrivacyState {
-    /** Transparency and Consent Framework (TCF) consent string v2.0
-See https://github.com/InteractiveAdvertisingBureau/GDPR-Transparency-and-Consent-Framework/blob/master/TCFv2/IAB%20Tech%20Lab%20-%20Consent%20string%20and%20vendor%20list%20formats%20v2.md */
     tcfConsentString?: string | undefined;
 }
 export interface PlaceAddress {
@@ -240,28 +184,21 @@ export interface PlaceAddress {
     addressLine2?: string;
     streetName?: string;
     locality?: string;
-    /** Full name of the state / province / territory */
     state?: string;
-    /** ISO 3166-2 - Two or three character subdivision code */
     stateCode?: string;
     postcode?: string;
-    /** Full name of the country */
     country?: string;
-    /** ISO 3166-2 - Two character country code */
     countryCode?: string;
     googlePlaceId?: string;
     timeZone?: TimeZoneInfo;
     geoLocation?: GeographicalCoordinate;
 }
 export interface TimeZoneInfo {
-    /** IANA timezone ID */
     friendlyId?: string;
     description?: string;
 }
 export interface GeographicalCoordinate {
-    /** Longitude */
     longitude?: number;
-    /** Latitude */
     latitude?: number;
 }
 export interface ShopifyPersonIdentifiers {
@@ -283,23 +220,15 @@ export interface WooCommercePersonIdentifiers {
     cartHash?: string[];
 }
 export interface BigCommercePersonIdentifiers {
-    /** BigCommerce  */
     customerId?: string[];
-    /** BigCommerce  */
     cartId?: string[];
-    /** BigCommerce  */
     orderId?: string[];
 }
 export interface MagentoPersonIdentifiers {
-    /** Magento customer */
     customerId?: string[];
-    /** Magento cart */
     cartId?: string[];
-    /** Magento order unique identifier */
     orderId?: string[];
-    /** Magento order number / incremental ID */
     orderNumber?: string[];
-    /** Magento checkout */
     checkoutId?: string[];
 }
 export interface ScopedIdentifiersOfKlaviyoPersonIdentifiersDtoAndString {
@@ -308,31 +237,18 @@ export interface ScopedIdentifiersOfKlaviyoPersonIdentifiersDtoAndString {
     };
 }
 export interface KlaviyoPersonIdentifiers {
-    /** Klaviyo profile ID */
     profileId?: string[] | undefined;
 }
 export interface TrackingEventSource {
-    /** Source method that requested the tracking. */
     method: string;
-    /** Type of origin that generated the tracking request.
-This is not the same as where the tracking event originated from, this property specifies where the tracking event was tracked from. */
     origin?: TrackingEventSourceOriginType | undefined;
-    /** Time occurred. Do not provide to use server time (recommended) */
     time?: Date | undefined;
-    /** URL where the tracking event originated from. */
     loc: string;
-    /** Title of the view or page where the tracking event originated from. */
     vt?: string | undefined;
-    /** Session ID where the tracking event originated from. UTC date.time and then random digits.
-Format YYYYMMDD.HHMMSS.{random 10 digits} */
     sess?: string | undefined;
-    /** Diagnosis session ID. UTC date.time and then random digits.
-Format YYYYMMDD.HHMMSS.{random 10 digits} */
     diag?: string | undefined;
     runtime?: SeekaSdkRuntimeInfo;
-    /** Context of the pipeline integration that raised the tracking event. */
     pipeline?: SeekaPipelineIntegrationSource | undefined;
-    /** IP address */
     ip?: string | undefined;
     device?: DeviceTrackingSource | undefined;
     privacy?: PrivacyState | undefined;
@@ -349,16 +265,12 @@ export declare enum TrackingEventSourceOriginType {
     Automatic = "automatic"
 }
 export interface SeekaSdkRuntimeInfo {
-    /** Version of the package or library being used to interact with the SDK */
     ver?: string;
-    /** Type of the package or library being used to interact with the SDK */
     type?: string;
     client?: SeekaSdkClientRuntimeInfo;
 }
 export interface SeekaSdkClientRuntimeInfo {
-    /** Client version used to identify the implementation of the SDK */
     ver?: string;
-    /** Name or type used to identify the implementation of the SDK. This could be specified as 'backend' for a backend integration with the SDK or 'website' for integrations placed on a website. */
     type?: string;
     origin?: SeekaSdkClientRuntimeOrigin | undefined;
 }
@@ -367,25 +279,16 @@ export interface SeekaSdkClientRuntimeOrigin {
 }
 export interface SeekaPipelineIntegrationSource {
     convergePipelineIntegrationInstanceId?: string;
-    /** The IntegrationVendorNameKey could be set to "Klaviyo" for all Klaviyo pipeline integration classes so that the rate limit for certain operations are shared across all Klaviyo integration instances that share the same IntegrationInstanceUniqueKey
-Alpha only
-Max length of 12 characters */
     integrationVendorNameKey?: string;
-    /** In format of IntegrationPublisherCompany.IntegrationVendorNameKey.IntegrationName. Eg. Seeka.Klaviyo.Identity */
     convergePipelineIntegrationTypeKey?: string;
 }
 export interface DeviceTrackingSource {
-    /** Browser name (Chrome, Firefox, Safari, etc) */
     bn?: string | undefined;
-    /** Browser version */
     bv?: string | undefined;
-    /** Platform name (Win32, OSX etc) */
     pl?: string | undefined;
-    /** Device fingerprint */
     fp?: string | undefined;
 }
 export interface DataIngestBatchHttpRequest {
-    /** Max batch size is 50 */
     data?: DataIngestBatchHttpItem[];
 }
 export interface DataIngestBatchHttpItem {
@@ -395,66 +298,39 @@ export interface DataIngestBatchHttpItem {
     log?: ActivityLogRequest | undefined;
 }
 export interface ActivityTrackingRequest {
-    /** Collection of identifiers used to calculate the identity graph. */
     id: PersonIdentifiers;
-    /** Source of the identification request. */
     src: TrackingEventSource;
-    /** Custom properties to attach to tracking event */
     props?: {
         [key: string]: string;
     };
-    /** UTM tracking information */
     utm?: UtmTrackingEvent[];
-    /** Activity tracking information */
     payload?: ActivityPayload;
 }
 export interface UtmTrackingEvent {
-    /** UTM ID */
     id?: string;
-    /** UTM content */
     content?: string;
-    /** UTM source */
     source?: string;
-    /** UTM campaign */
     campaign?: string;
-    /** UTM term */
     term?: string;
-    /** UTM medium */
     medium?: string;
 }
 export interface ActivityPayloadBase {
-    /** Standard or custom activity / behavior activity name. */
     activityName?: TrackingActivityNames;
-    /** Required if ActivityName is set to Custom.
-When setting this parameter in conjunction with setting ActivityName to a standard event name, Seeka will process the event
-as a standard event with the exception of conversion based data destinations being sent the event as the ActivityNameCustom value
-with the parameters of the standard event.  */
     activityNameCustom?: string;
-    /** Unique identifier used to de-duplicate activities */
     activityId?: string;
-    /** E-Commerce specific activity properties */
     commerce?: CommerceActivityTrackingEventMetadata;
-    /** Search function specific activity properties */
     search?: SearchActivityTrackingEventMetadata;
-    /** Sign up / newsletter function specific activity properties */
     signUp?: SignUpActivityTrackingEventMetadata;
-    /** User account specific activity properties */
     userAccount?: UserAccountActivityTrackingEventMetadata;
-    /** Promotion specific activity properties */
     promotion?: PromotionalActivityTrackingEventMetadata;
-    /** Content behavior specific activity properties */
     contentBehaviour?: ContentBehaviourActivityTrackingEventMetadata;
-    /** Lead activity properties */
     lead?: LeadActivityTrackingEventMetadata;
-    /** Content item activity properties */
     contentItem?: ContentItemActivityTrackingEventMetadata;
-    /** Custom properties attached to the tracking event */
     properties?: {
         [key: string]: string;
     };
 }
 export interface ActivityPayload extends ActivityPayloadBase {
-    /** Time activity occurred. Do not provide to use server time (recommended) */
     time?: Date | undefined;
 }
 export declare enum TrackingActivityNames {
@@ -488,72 +364,39 @@ export declare enum TrackingActivityNames {
 }
 export interface CommerceActivityTrackingEventMetadata {
     products?: CommerceActivityTrackingEventProductMetadata[];
-    /** Identifier of the checkout */
     checkoutIdentifier?: string;
-    /** Identifier of the cart */
     cartIdentifier?: string;
-    /** Identifier of the order */
     orderIdentifier?: string;
-    /** Incremental ID of the order */
     orderNumber?: string;
-    /** Identifier of the customer */
     customerIdentifier?: string;
-    /** Where the order was placed */
     sourceChannelName?: string;
-    /** Type of the e-commerce platform */
     platformType?: ECommercePlatform;
-    /** Payment method name */
     paymentMethodName?: string;
-    /** ISO 4217 3 letter currency code */
     currencyCode?: string;
-    /** Test order */
     isTest?: boolean;
-    /** Total refunds */
     totalRefunds?: number | undefined;
-    /** Total discounts */
     totalDiscounts?: number | undefined;
-    /** Total sum of all the line items in the order
-Can be left empty to auto calculate */
     totalLineItemsPrice?: number | undefined;
-    /** Total price of the order paid by the purchaser */
     totalPrice?: number | undefined;
-    /** Total tax */
     totalTax?: number | undefined;
-    /** Total shipping price */
     totalShippingPrice?: number | undefined;
-    /** Fulfillment status */
     fulfillmentStatus?: ECommerceFulfillmentStatus | undefined;
-    /** Financial status */
     financialStatus?: ECommerceFinancialStatus | undefined;
 }
 export interface CommerceActivityTrackingEventProductMetadata {
-    /** ISO 4217 currency code */
     currencyCode?: string;
-    /** Product ID */
     productIdentifier?: string;
-    /** Variant ID */
     variantIdentifier?: string;
-    /** SKU */
     sku?: string;
-    /** Identifier of the line item */
     lineItemIdentifier?: string;
-    /** Name of product */
     productName?: string;
-    /** Name of variant */
     variantName?: string;
-    /** Name of category */
     categoryName?: string;
-    /** Brand of the item */
     brandName?: string;
-    /** Price of a single item */
     unitPrice?: number | undefined;
-    /** Quantity */
     quantity?: number | undefined;
-    /** Total discounts */
     totalDiscount?: number | undefined;
-    /** Type of product or collection */
     type?: ECommerceContentType | undefined;
-    /** Additional attributes of the product */
     attributes?: {
         [key: string]: any;
     };
@@ -574,7 +417,6 @@ export declare enum ECommercePlatform {
     WooCommerce = "wooCommerce",
     Demandware = "demandware"
 }
-/** https://shopify.dev/api/admin-rest/2022-01/resources/order#resource-object */
 export declare enum ECommerceFulfillmentStatus {
     Undefined = "undefined",
     Fulfilled = "fulfilled",
@@ -583,7 +425,6 @@ export declare enum ECommerceFulfillmentStatus {
     RestockedOrCancelled = "restockedOrCancelled",
     Pending = "pending"
 }
-/** https://shopify.dev/api/admin-rest/2022-01/resources/order#resource-object */
 export declare enum ECommerceFinancialStatus {
     Undefined = "undefined",
     Pending = "pending",
@@ -608,31 +449,20 @@ export interface PromotionalActivityTrackingEventMetadata {
     code?: string;
 }
 export interface ContentBehaviourActivityTrackingEventMetadata {
-    /** Behavior that changes or customised a product via an attribute. */
     changeProduct?: ChangeProductAttributeActivityTrackingEventMetadata;
-    /** Behavior that filters a list of items or content via an attribute. */
     filterItems?: FilterItemsByAttributeActivityTrackingEventMetadata;
 }
 export interface ChangeProductAttributeActivityTrackingEventMetadata {
-    /** Name of the type of attribute. */
     attributeTypeName?: string;
-    /** Previous value of the attribute before the change. */
     previousAttributeValue?: string;
-    /** Value the attribute was changed to. */
     newAttributeValue?: string;
-    /** Product that relates to attribute change. */
     product?: CommerceActivityTrackingEventProductMetadata;
 }
 export interface FilterItemsByAttributeActivityTrackingEventMetadata {
-    /** Name of the type of attribute that is being filtered by. */
     attributeTypeName?: string;
-    /** String value of the filter. Use only one of StringValue, NumericValue, BooleanValue or DateValue properties. */
     stringValue?: string;
-    /** Numerical value of the filter. Use only one of StringValue, NumericValue, BooleanValue or DateValue properties. */
     numericValue?: number | undefined;
-    /** Date value of the filter. Use only one of StringValue, NumericValue, BooleanValue or DateValue properties. */
     dateValue?: Date | undefined;
-    /** Boolean (true/false) value of the filter. Use only one of StringValue, NumericValue, BooleanValue or DateValue properties. */
     booleanValue?: boolean | undefined;
 }
 export interface LeadActivityTrackingEventMetadata {
@@ -641,14 +471,12 @@ export interface LeadActivityTrackingEventMetadata {
     companyName?: string;
     predictedLtv?: number | undefined;
     predictedValue?: number | undefined;
-    /** ISO 4217 currency code */
     currencyCode?: string;
 }
 export interface ContentItemActivityTrackingEventMetadata {
     contentName?: string;
     identifiers?: string[];
     categoryName?: string;
-    /** ISO 4217 currency code */
     currencyCode?: string;
     value?: number | undefined;
     contentType?: ECommerceContentType | undefined;
@@ -699,9 +527,7 @@ export declare enum SeekaWebhookCallType {
 }
 export interface SeekaWebhookPayload {
     type?: SeekaWebhookCallType;
-    /** Determines if the webhook is sent as a result of a test call */
     isTest?: boolean;
-    /** Unique identifier for the webhook request */
     requestId?: string;
     causationId?: string | undefined;
 }
@@ -709,13 +535,9 @@ export interface SeekaWebhookPayloadOfSeekaAppWebhookContext extends SeekaWebhoo
     context?: SeekaAppWebhookContext;
 }
 export interface SeekaAppWebhookContext {
-    /** ID of the organisation that installed the app */
     organisationId?: string;
-    /** ID of the brand that installed the app */
     organisationBrandId?: string;
-    /** Pipeline integration ID / ID of the installation of the app */
     applicationInstallId?: string;
-    /** The client / application ID */
     applicationId?: string;
 }
 export interface SeekaBrowserSdkPluginWebhookResponse {
@@ -729,7 +551,6 @@ export interface SeekaAppInstalledWebhookContent {
     installationSettings?: {
         [key: string]: any;
     };
-    /** The permissions granted to the app install by the user that installed the app. */
     grantedPermissions?: string[];
 }
 export interface SeekaAppInstalledWebhookPayload extends SeekaWebhookPayloadOfSeekaAppWebhookContext {
@@ -753,7 +574,6 @@ export interface SeekaAppInstallSettingsUpdatedWebhookContent {
     installationSettings?: {
         [key: string]: any;
     };
-    /** The permissions granted to the app install by the user that installed the app. */
     grantedPermissions?: string[];
 }
 export interface SeekaAppInstallSettingsUpdatedWebhookPayload extends SeekaWebhookPayloadOfSeekaAppWebhookContext {
@@ -763,19 +583,13 @@ export interface SeekaWebhookPayloadOfSeekaAppWebhookContextAndSeekaActivityAcce
     content?: SeekaActivityAcceptedWebhookContent;
 }
 export interface SeekaActivityAcceptedWebhookContent {
-    /** Source of the activity */
     source?: TrackingEventSource;
-    /** Identifiers resolved to the activity */
     identifiers?: PersonIdentifiers;
-    /** Activity metadata */
     activity?: WebsiteEventActivityAppsPayload;
-    /** Attribution metadata */
     attribution?: AttributionInfo | undefined;
-    /** Seeka Person ID - Identity Graph ID */
     personId?: string;
 }
 export interface WebsiteEventActivityAppsPayload extends ActivityPayloadBase {
-    /** Time activity occurred */
     time?: Date;
 }
 export interface AttributionInfo {
@@ -831,9 +645,7 @@ export declare enum ConditionComparer {
 export interface ActivityPipelineActivityFilterSourceItem {
     label?: string;
     type?: ActivityPipelineActivityFilterSourceItemType;
-    /** Criteria to match against. */
     key?: string;
-    /** If key is null, this is the criteria to match against. */
     textMatch?: TextMatchInfo | undefined;
 }
 export declare enum ActivityPipelineActivityFilterSourceItemType {
@@ -846,7 +658,6 @@ export declare enum ActivityPipelineActivityFilterSourceItemType {
 }
 export interface TextMatchInfo {
     operator?: ConditionOperator;
-    /** Can be a JSON string, number (as string), regex expression or text depending on the operator */
     matchValue?: string | undefined;
 }
 export declare enum ConditionOperator {
@@ -891,16 +702,11 @@ export interface PipelineRuleActivityModifiers {
     pipelineRuleId?: string;
     activityName?: TrackingActivityNames;
     activityNameCustom?: string;
-    /** If provided, this will override the activity name sent to the platform.
-This will disable normalising (eg. AddToCart -> add_to_cart) and also disable changing of the
-activity name casing. */
     activityNameOverride?: string;
     id?: string;
 }
 export interface ConvergeEmbedTrackingWebsiteConfiguration {
-    /** SEEKA API endpoint */
     endpoint?: string;
-    /** SEEKA API ingestion endpoint */
     ingestEndpoint?: string;
     isDomainIngestRulesEnabled?: boolean;
     debug?: ConvergeEmbedTrackingWebsiteDebugConfiguration;
@@ -910,17 +716,12 @@ export interface ConvergeEmbedTrackingWebsiteConfiguration {
     browserSdkVersion?: string;
 }
 export interface ConvergeEmbedTrackingWebsiteDebugConfiguration {
-    /** Enables debugging on browser SDK. This setting is strongly not recommended to be kept enabled in production environments.  */
     isEnabled?: boolean;
-    /** Enables diagnosis on browser SDK. This setting is strongly not recommended to be kept enabled in production environments.  */
     isDiagnosisEnabled?: boolean;
 }
 export interface ConvergeEmbedTrackingJsTenantDefaultsConfiguration {
-    /** ISO 4217 currency code to use as a fallback if events ingested do not carry the parameter. */
     currencyCode?: string;
-    /** ISO 3166-2 country code to use as a fallback if events ingested do not carry the parameter. */
     countryCode?: string;
-    /** IANA timezone ID to use as a fallback if events ingested do not carry the parameter. */
     timezoneId?: string;
 }
 export interface ConvergeEmbedTrackingJsTenantAnalyticsConfigurationBase {
@@ -942,9 +743,7 @@ export interface ConvergeEmbedTrackingJsTenantAnalyticsLibrariesConfiguration {
     pinterestPixel?: ConvergeEmbedTrackingJsAnalyticsLibraryActivityConfiguration;
 }
 export interface ConvergeEmbedTrackingJsAnalyticsLibraryActivityConfiguration {
-    /** Whether push of events to the platform is enabled. */
     isPushEnabled?: boolean;
-    /** The library to push event to. */
     library?: AnalyticsLibrary;
 }
 export interface SeekaConvergeEmbedTrackingJsAnalyticsLibraryActivityConfiguration extends ConvergeEmbedTrackingJsAnalyticsLibraryActivityConfiguration {
@@ -963,29 +762,21 @@ export declare enum AnalyticsLibrary {
     GoogleAds = "googleAds"
 }
 export interface GoogleAnalyticsConvergeEmbedTrackingJsAnalyticsLibraryActivityConfiguration extends ConvergeEmbedTrackingJsAnalyticsLibraryActivityConfiguration {
-    /** Additional tags to be used for tracking which will be configured on every page via the gtag('config', ...) command. */
     googleTags?: GoogleAnalyticsConvergeEmbedTrackingJsAnalyticsLibraryTagConfiguration[];
-    /** Used to augment product IDs sent to Google Analytics for use with Google Merchant Center. */
     merchant?: GoogleAnalyticsConvergeEmbedTrackingJsAnalyticsLibraryMerchantConfiguration;
 }
 export interface GoogleAnalyticsConvergeEmbedTrackingJsAnalyticsLibraryTagConfiguration {
-    /** The ID of the tag. */
     tagId?: string;
     phoneConversions?: GoogleAnalyticsConvergeEmbedTrackingJsAnalyticsLibraryPhoneConversionConfiguration[];
 }
 export interface GoogleAnalyticsConvergeEmbedTrackingJsAnalyticsLibraryPhoneConversionConfiguration {
-    /** The phone number in human form as it appears on the page. This number will be replaced by Google to allow them to track inbound calls. */
     phoneConversionNumber?: string;
-    /** The label of the conversion. */
     conversionLabel?: string;
 }
 export interface GoogleAnalyticsConvergeEmbedTrackingJsAnalyticsLibraryMerchantConfiguration {
-    /** Used to augment product IDs sent to Google Analytics for use with Google Merchant Center. */
     productItemIdPrefix?: string;
-    /** Used to augment product IDs sent to Google Analytics for use with Google Merchant Center. */
     productItemIdBehavior?: ContentIdentificationBehavior | undefined;
 }
-/** Defines the behavior to identify content based on product ID, variant ID or SKU when sending events to platforms. */
 export declare enum ContentIdentificationBehavior {
     Default = "default",
     Sku = "sku",
@@ -995,9 +786,7 @@ export declare enum ContentIdentificationBehavior {
     VariantIdOrProductId = "variantIdOrProductId"
 }
 export interface FacebookPixelConvergeEmbedTrackingJsAnalyticsLibraryActivityConfiguration extends ConvergeEmbedTrackingJsAnalyticsLibraryActivityConfiguration {
-    /** Test event code as retrieved from your Facebook Events Manager for diagnosing and debugging events. */
     testEventCode?: string;
-    /** Publish strategy */
     publishMode?: ConvergeVendorDestinationPublishStrategy;
 }
 export declare enum ConvergeVendorDestinationPublishStrategy {
@@ -1007,7 +796,6 @@ export declare enum ConvergeVendorDestinationPublishStrategy {
     DeliverMaxWeightedTraitsOnlyAndDeliverEventsOnlyIfMaxWeightedTraitsPresent = "deliverMaxWeightedTraitsOnlyAndDeliverEventsOnlyIfMaxWeightedTraitsPresent"
 }
 export interface TikTokPixelConvergeEmbedTrackingJsAnalyticsLibraryActivityConfiguration extends ConvergeEmbedTrackingJsAnalyticsLibraryActivityConfiguration {
-    /** Publish mode */
     publishMode?: ConvergeVendorDestinationPublishStrategy;
 }
 export interface DynamicYieldConvergeEmbedTrackingJsAnalyticsLibraryActivityConfiguration extends ConvergeEmbedTrackingJsAnalyticsLibraryActivityConfiguration {
@@ -1018,34 +806,19 @@ export interface SegmentConvergeEmbedTrackingJsAnalyticsLibraryActivityConfigura
     writeKey?: string;
 }
 export interface ConvergeEmbedTrackingJsAutoCollectionConfiguration {
-    /** Activities or events that will be automatically collected from user behaviour. */
     activityNames?: TrackingActivityNames[];
-    /** Name of query parameter that contains the search text for site searches.
-A KeywordSearchQueryParamName of 'q' will resolve the search text 'awesome product' from the url https://examplewebsite.com?q=awesome%20product */
     keywordSearchQueryParamName?: string;
-    /** Regex to match and identify order status page URL for the site to allow for automatic order event collection. */
     orderSuccessUrlPathMatchRegex?: string;
     activityDefinitions?: ConvergeEmbedTrackingActivityDefinition[];
-    /** The currency amount to apply to activities sent to data destinations that require a value
-but no value was provided in the tracking.  */
     defaultActivityCurrencyAmount?: CurrencyAmount | undefined;
-    /** Milliseconds to wait until initialising the interceptors that support automatic activity collection.
-Null or 0 will disable the delay and initialise the interceptors immediately.
--1 will disable the interceptors. */
     interceptorStartDelayMs?: number | undefined;
 }
 export interface ConvergeEmbedTrackingActivityDefinition {
     triggerSettings?: ConvergeEmbedTrackingActivityDefinitionTriggerSettings;
     vendorSettings?: ConvergeEmbedTrackingActivityDefinitionVendorSettings;
     consentSettings?: ConvergeEmbedTrackingActivityDefinitionConsentSettings;
-    /** Standard or custom activity / behavior activity name. */
     activityName?: TrackingActivityNames;
-    /** Required if ActivityName is set to Custom.
-When setting this parameter in conjunction with setting ActivityName to a standard event name, Seeka will process the event
-as a standard event with the exception of conversion based data destinations being sent the event as the ActivityNameCustom value
-with the parameters of the standard event. */
     activityNameCustom?: string | undefined;
-    /** Parameters to be sent with the activity. */
     activityParameters?: {
         [key: string]: any;
     };
@@ -1055,46 +828,31 @@ with the parameters of the standard event. */
 }
 export interface ConvergeEmbedTrackingActivityDefinitionTriggerSettings {
     schemaVersion?: number;
-    /** Specify if all or one triggers should raise the activity */
     firingTriggersComparer?: ConditionComparer;
     firingTriggers?: ConvergeEmbedTrackingActivityDefinitionTrigger[] | undefined;
-    /** Specify if all or one triggers should raise the activity */
     blockingTriggersComparer?: ConditionComparer;
     blockingTriggers?: ConvergeEmbedTrackingActivityDefinitionTrigger[] | undefined;
     triggerComparer?: ConditionComparer | undefined;
     triggers?: ConvergeEmbedTrackingActivityDefinitionTriggerV1[] | undefined;
 }
 export interface ConvergeEmbedTrackingActivityDefinitionTrigger extends ActivityPipelineActivitySourceFilter {
-    /** The HTML elements that if captured should cause this trigger to match. */
     htmlElements?: ConvergeEmbedTrackingActivityDefinitionTriggerHtmlElement[] | undefined;
 }
 export interface ConvergeEmbedTrackingActivityDefinitionTriggerHtmlElement {
     locator?: HtmlElementLocator;
-    /** The HTML element event types that if captured on the locator HTML element should cause this trigger to match. https://developer.mozilla.org/en-US/docs/Web/Events. */
     eventTypes?: string[];
 }
 export interface HtmlElementLocator {
-    /** List of HTML element class names to match. */
     classNames?: string[] | undefined;
-    /** HTML elements type name to match. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element for list.
-button */
     elementTypes?: string[] | undefined;
-    /** ID of the HTML element to match. */
     elementId?: string | undefined;
-    /** HTML element type name to match. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element for list.
-button */
     elementType?: string;
-    /** Inner text of the HTML element to match.  */
     innerText?: string | undefined;
-    /** Inner text of the HTML element to match.  */
     innerTextMatch?: TextMatchInfo | undefined;
-    /** ID of the HTML element to match. */
     elementIdMatch?: TextMatchInfo | undefined;
-    /** URL of the anchor, button etc. HTML element to match. */
     linkUrlMatch?: TextMatchInfo | undefined;
 }
 export interface ConvergeEmbedTrackingActivityDefinitionTriggerV1 {
-    /** Regex to match a URL path to trigger the activity. */
     urlPathMatchRegex?: string;
     htmlElement?: ConvergeEmbedTrackingActivityDefinitionTriggerHtmlElement;
 }
@@ -1105,24 +863,16 @@ export interface ConvergeEmbedTrackingActivityDefinitionGoogleTriggerSettings {
     googleAdsConversionTriggers?: GoogleAdsConversionTriggerData[];
 }
 export interface GoogleAdsConversionTriggerData {
-    /** Conversion ID */
     conversionId?: string;
-    /** Conversion label */
     conversionLabel?: string;
 }
 export interface ConvergeEmbedTrackingActivityDefinitionConsentSettings {
-    /** Grant for sending data to 3rd party analytics and marketing platforms. */
     analytics?: ConvergeEmbedTrackingActivityDefinitionConsentTypeSettings;
-    /** Grant for marketing via re-marketing campaigns, EDMs etc.  */
     marketing?: ConvergeEmbedTrackingActivityDefinitionMarketingConsentSettings;
-    /** Grant for enrolling and participating in loyalty programs.  */
     loyalty?: ConvergeEmbedTrackingActivityDefinitionConsentTypeSettings;
 }
 export interface ConvergeEmbedTrackingActivityDefinitionConsentTypeSettings {
-    /** The name of the source that provided the grant information. Set to the source platform like Shopify, Wordpress or your custom integration client name.
-If this is left empty then the source of the data will be assumed. Eg for an event fired on a website the source name will be set to the domain name of the website. */
     consentSourceName?: string | undefined;
-    /** If the consent has been granted or not granted. */
     consentGranted?: boolean | undefined;
 }
 export interface ConvergeEmbedTrackingActivityDefinitionMarketingConsentSettings {
@@ -1131,32 +881,23 @@ export interface ConvergeEmbedTrackingActivityDefinitionMarketingConsentSettings
 }
 export interface CurrencyAmount {
     amount?: number;
-    /** ISO 4217 currency code */
     currencyCode?: string;
-    /** Currency symbol */
     currencySymbol?: string;
 }
 export interface ConvergeEmbedTrackingJsIdentityConfiguration {
-    /** The timeout to inform the time to live for a user session. */
     userSessionTimeoutSeconds?: number;
 }
 export interface ConvergeEmbedTrackingJsTenantAnalyticsCrossDomainConfiguration {
     rules?: CrossDomainTrackingDomainRule[] | undefined;
 }
 export interface CrossDomainTrackingDomainRule {
-    /** The hostname to match for the source hostname.
-If the source hostname matches the current URL, links matching the destination link will be modified. */
     sourceHostname?: TextMatchInfo;
-    /** The link to match.
-If the source hostname matches the current URL, links matching the destination link will be modified. */
     destinationLink: TextMatchInfo;
     identifiers?: CrossDomainTrackingDomainRuleIdentifierSettings;
     utm?: CrossDomainTrackingDomainRuleUtmSettings;
     id?: string;
 }
 export interface CrossDomainTrackingDomainRuleIdentifierSettings {
-    /** If disabled, Seeka will not append Seeka profile ID and ad platform identifiers
-onto the destination URL. */
     isIdentifierPassthroughDisabled?: boolean;
 }
 export interface CrossDomainTrackingDomainRuleUtmSettings {
@@ -1168,44 +909,24 @@ export declare enum CrossDomainTrackingUtmBehavior {
     UrlPassthrough = "urlPassthrough"
 }
 export interface ConvergeEmbedTrackingWebsiteProcessingConfiguration {
-    /** Disable browser events from being sent from the browser to platforms and SEEKA API directly. */
     isBrowserEventsDisabled?: boolean;
-    /** Disable events from being ingested by SEEKA API. This will also disable the delivery of events to platforms.  */
     isServerEventsDisabled?: boolean;
-    /** Disable identity resolution on the browser SDK. */
     isIdentityDisabled?: boolean;
-    /** Controls identity resolution delay. */
     publishToVendorsTimeoutSeconds?: number | undefined;
-    /** Amount of time to retain untouched anonymous/partial identities for until purging. */
     anonymousIdentityRetentionPeriod?: string | undefined;
-    /** Amount of time to retain untouched enriched/partial identities for until purging. */
     enrichedIdentityRetentionPeriod?: string | undefined;
-    /** Defines the behavior to identify content based on product ID, variant ID or SKU when sending events to platforms. */
     contentIdentificationBehavior?: ContentIdentificationBehavior | undefined;
-    /** JavaScript object reference that all Converge.track and Converge.identity api calls will be mediated to.
-Can be used to forward all tracking calls to Shopify.analytics.publish('seeka_mediate', { api: 'track', method: TrackingActivityNames.AddToCart, params: [{ productIdentifier: '123' }, commonProps] }) by setting this to Shopify.analytics.publish. */
     mediateBrowserMethodsToWindowReference?: string;
-    /** Consent management settings. */
     consent?: ConsentSettings | undefined;
-    /** Privacy data control settings */
     privacyDataControl?: PrivacyDataControlSettings | undefined;
 }
 export interface ConsentSettings {
-    /** Settings for regional consent management. */
     regionalConsent?: RegionalConsentSettings[] | undefined;
-    /** Settings for consent management platforms. */
     consentManagementPlatform?: ConsentManagementPlatformSettings | undefined;
-    /** If using a consent management platform, this should be set to true to disable Seeka's consent management. */
     disableConsentManagement?: boolean;
 }
 export interface RegionalConsentSettings {
-    /** ISO-3166-1 alpha-2 country code
-See https://en.wikipedia.org/wiki/ISO_3166-2 for list.
-Should be null for "default" / "fallback" settings. */
     countryCode?: string | undefined;
-    /** ISO-3166-1 alpha-2 subdivision code
-See https://en.wikipedia.org/wiki/ISO_3166-2 for list.
-/// Should be null for "default" region or for targeting a whole country when used in conjunction with CountryCode. */
     subdivisionCode?: string | undefined;
     configuration?: ConsentConfiguration;
 }
@@ -1230,10 +951,7 @@ export interface OneTrustConsentManagementPlatformSettings {
     purposeMappings?: OneTrustConsentManagementPurposeMapping[];
 }
 export interface OneTrustConsentManagementPurposeMapping {
-    /** The IAB purpose ID that maps to the OneTrust categories. */
     iabPurposeId?: IabPrivacyConsentPurposeId;
-    /** OneTrust category IDs that map to the IAB purpose.
-C0001 */
     oneTrustCategoryIds?: string[];
     matchType?: ConsentMappingMatchType;
 }
@@ -1255,9 +973,7 @@ export declare enum PrivacyDataControlMode {
     Implicit = "implicit"
 }
 export interface ConvergeTrackingConfiguration {
-    /** SEEKA API endpoint */
     endpoint?: string;
-    /** SEEKA API ingestion endpoint */
     ingestEndpoint?: string;
     isDomainIngestRulesEnabled?: boolean;
     debug?: ConvergeEmbedTrackingWebsiteDebugConfiguration;
@@ -1286,15 +1002,11 @@ export declare class ApiException extends Error {
     static isApiException(obj: any): obj is ApiException;
 }
 export interface AppClientRuntimeInfo {
-    /** Client version used to identify the implementation of the SDK */
     ver: string;
-    /** Name or type used to identify the implementation of the SDK. This could be specified as 'backend' for a backend integration with the SDK or 'website' for integrations placed on a website. */
     type: string;
 }
 export interface AppRuntimeInfo {
-    /** Version of the package or library being used to interact with the SDK */
     ver: string;
-    /** Type of the package or library being used to interact with the SDK */
     type: string;
     client: AppClientRuntimeInfo;
 }