@seeka-labs/sdk-apps-server 1.0.1

package/dist/types/src/api/services/index.d.ts

@@ -0,0 +1,751 @@
+import { Logger } from 'winston';
+import type { AxiosInstance, AxiosRequestConfig, AxiosResponse, CancelToken } from 'axios';
+export declare class SeekaAppConfig {
+    appId: string;
+    appSecret: string;
+    ingestUrl: string;
+    issuerUrl: string;
+    organisationId: string;
+    applicationInstallId: string;
+    runtime: AppRuntimeInfo;
+    logger?: Logger;
+    grantedPermissions: string[];
+    transformApiRequest: (options: AxiosRequestConfig) => Promise<AxiosRequestConfig>;
+    transformApiResponse: (url: string, response: AxiosResponse<any, any>, processor: (response: AxiosResponse<any, any>) => any) => any;
+    hasAnyPermissions: (permissionKeys: string[]) => boolean;
+    hasAllPermissions: (permissionKeys: string[]) => boolean;
+    hasPermission: (permissionKey: string) => boolean;
+}
+export declare class ApiServiceProxyBase {
+    private readonly config;
+    protected constructor(config: SeekaAppConfig);
+    protected transformOptions: (options: AxiosRequestConfig) => Promise<AxiosRequestConfig>;
+    protected transformResult: (url: string, response: AxiosResponse<any, any>, processor: (response: AxiosResponse<any, any>) => any) => Promise<any>;
+}
+export declare class IdentityServiceProxy extends ApiServiceProxyBase {
+    protected instance: AxiosInstance;
+    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>;
+}
+export declare class IngestServiceProxy extends ApiServiceProxyBase {
+    protected instance: AxiosInstance;
+    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>;
+}
+export interface ApiResponseDtoOfPersonIdentificationResolutionResponse {
+    result?: PersonIdentificationResolutionResponse;
+}
+export interface PersonIdentificationResolutionResponse {
+    personId?: string;
+}
+export interface ApiResponseDtoOfObject {
+    result?: any;
+}
+export interface DetailedApiResponseDtoOfObject extends ApiResponseDtoOfObject {
+    type?: ResponseResultType;
+    error?: ErrorInfo;
+    success?: boolean;
+}
+export interface ApiResponseErrorDtoOfObject extends DetailedApiResponseDtoOfObject {
+}
+export interface ApiResponseError extends ApiResponseErrorDtoOfObject {
+}
+export declare enum ResponseResultType {
+    Undefined = "undefined",
+    Success = "success",
+    Failed = "failed"
+}
+export interface ErrorInfo {
+    message?: string;
+    code?: number;
+    correlationId?: string;
+    validation?: ValidationSummary;
+}
+export interface ValidationSummary {
+    properties?: PropertyValidationError[];
+}
+export interface PropertyValidationError {
+    errorKey?: string;
+    helpActions?: HelpAction[];
+    propertyName?: string;
+    attemptedValue?: any;
+    errorMessage?: string;
+    children?: PropertyValidationError[];
+}
+export interface HelpAction {
+    helpActionUrl?: string;
+    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[];
+    /** 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[];
+}
+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;
+}
+export interface ConsentInfo {
+    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 {
+    Unknown = "unknown",
+    Informed = "informed",
+    Implied = "implied",
+    Explicit = "explicit",
+    Active = "active",
+    Passive = "passive"
+}
+export interface MarketingConsentInfo {
+    email?: ConsentInfo;
+    sms?: ConsentInfo;
+}
+export interface PlaceAddress {
+    description?: string;
+    addressLine1?: string;
+    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?: number;
+    latitude?: number;
+}
+export interface ShopifyPersonIdentifiers {
+    customerId?: string[];
+    uniqueToken?: string[];
+    microSessionId?: string[];
+    visitToken?: string[];
+    cartToken?: string[];
+    checkoutToken?: string[];
+    cartId?: string[];
+    deviceId?: string[];
+    checkoutId?: string[];
+    orderId?: string[];
+    sessionHash?: string[];
+}
+export interface WooCommercePersonIdentifiers {
+    customerId?: string[];
+    orderId?: string[];
+    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 {
+    data?: {
+        [key: string]: KlaviyoPersonIdentifiers;
+    };
+}
+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;
+    /** 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;
+}
+export declare enum TrackingEventSourceOriginType {
+    Browser = "browser",
+    Server = "server",
+    Mobile = "mobile",
+    Desktop = "desktop",
+    PhysicalStore = "physicalStore",
+    Email = "email",
+    Phone = "phone",
+    Chat = "chat",
+    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;
+    config?: any;
+    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;
+}
+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 DataIngestBatchHttpRequest {
+    /** Max batch size is 50 */
+    data?: DataIngestBatchHttpItem[];
+}
+export interface DataIngestBatchHttpItem {
+    ev?: ActivityTrackingRequest;
+    id?: PersonIdentificationRequest;
+    bot?: BotMetricTrackingRequest;
+    log?: ActivityLogRequest;
+}
+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 {
+    Undefined = "undefined",
+    PageViewOrganic = "pageViewOrganic",
+    PageViewUtmAttributed = "pageViewUtmAttributed",
+    AddPaymentMethod = "addPaymentMethod",
+    AddToWishlist = "addToWishlist",
+    ContactMessage = "contactMessage",
+    Custom = "custom",
+    SyncCart = "syncCart",
+    Order = "order",
+    InitiateCheckout = "initiateCheckout",
+    AddToCart = "addToCart",
+    RemoveFromCart = "removeFromCart",
+    OneTimeItemPurchase = "oneTimeItemPurchase",
+    SubscriptionItemPurchase = "subscriptionItemPurchase",
+    ViewProduct = "viewProduct",
+    ViewPage = "viewPage",
+    ApplyPromotionalCode = "applyPromotionalCode",
+    KeywordSearch = "keywordSearch",
+    UserLoginSignup = "userLoginSignup",
+    UserLogin = "userLogin",
+    NewsletterSignup = "newsletterSignup",
+    Lead = "lead",
+    ChangeProductAttribute = "changeProductAttribute",
+    FilterItemsByAttribute = "filterItemsByAttribute",
+    Schedule = "schedule",
+    ViewContentItem = "viewContentItem",
+    StartTrial = "startTrial"
+}
+export interface CommerceActivityTrackingEventMetadata {
+    products?: CommerceActivityTrackingEventProductMetadata[];
+    checkoutIdentifier?: string;
+    cartIdentifier?: string;
+    orderIdentifier?: string;
+    orderNumber?: string;
+    customerIdentifier?: string;
+    sourceChannelName?: string;
+    platformType?: ECommercePlatform;
+    paymentMethodName?: string;
+    currencyCode?: string;
+    isTest?: boolean;
+    totalRefunds?: number | undefined;
+    totalDiscounts?: number | undefined;
+    totalLineItemsPrice?: number | undefined;
+    totalPrice?: number | undefined;
+    totalTax?: number | undefined;
+    totalShippingPrice?: number | undefined;
+    fulfillmentStatus?: ECommerceFulfillmentStatus | undefined;
+    financialStatus?: ECommerceFinancialStatus | undefined;
+}
+export interface CommerceActivityTrackingEventProductMetadata {
+    /** ISO 4217 currency code */
+    currencyCode?: string;
+    productIdentifier?: string;
+    variantIdentifier?: string;
+    sku?: string;
+    lineItemIdentifier?: string;
+    productName?: string;
+    variantName?: string;
+    categoryName?: string;
+    brandName?: string;
+    unitPrice?: number | undefined;
+    quantity?: number | undefined;
+    totalDiscount?: number | undefined;
+    type?: ECommerceContentType | undefined;
+    attributes?: {
+        [key: string]: any;
+    };
+}
+export declare enum ECommerceContentType {
+    Undefined = "undefined",
+    SingleProduct = "singleProduct",
+    SingleVariant = "singleVariant",
+    Collection = "collection"
+}
+export declare enum ECommercePlatform {
+    None = "none",
+    BigCommerce = "bigCommerce",
+    Shopify = "shopify",
+    OrderGroove = "orderGroove",
+    Magento = "magento",
+    Generic = "generic",
+    WooCommerce = "wooCommerce",
+    Demandware = "demandware"
+}
+/** https://shopify.dev/api/admin-rest/2022-01/resources/order#resource-object */
+export declare enum ECommerceFulfillmentStatus {
+    Undefined = "undefined",
+    Fulfilled = "fulfilled",
+    NoneFulfilled = "noneFulfilled",
+    PartiallyFulfilled = "partiallyFulfilled",
+    RestockedOrCancelled = "restockedOrCancelled"
+}
+/** https://shopify.dev/api/admin-rest/2022-01/resources/order#resource-object */
+export declare enum ECommerceFinancialStatus {
+    Undefined = "undefined",
+    Pending = "pending",
+    Authorized = "authorized",
+    PartiallyPaid = "partiallyPaid",
+    Paid = "paid",
+    PartiallyRefunded = "partiallyRefunded",
+    Refunded = "refunded",
+    Voided = "voided"
+}
+export interface SearchActivityTrackingEventMetadata {
+    searchText?: string;
+}
+export interface UserAccountActivityTrackingEventMetadata {
+    emailAddress?: string | undefined;
+    userAccountIdentifierValue?: string | undefined;
+    userAccountIdentifierTypeName?: string | undefined;
+}
+export interface SignUpActivityTrackingEventMetadata extends UserAccountActivityTrackingEventMetadata {
+}
+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 {
+    sourceContentName?: string;
+    companySize?: string;
+    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;
+    items?: CommerceActivityTrackingEventProductMetadata[];
+}
+export interface BotMetricTrackingRequest extends PersonIdentificationRequest {
+}
+export interface ActivityTrackingBase {
+    id?: string;
+    source?: TrackingEventSource;
+    properties?: {
+        [key: string]: string;
+    };
+    utm?: UtmTrackingEvent;
+}
+export interface ActivityLogRequest extends ActivityTrackingBase {
+    logType?: ConvergePipelineLoggableActivityType;
+    logLevel?: SdkLogEventLevel;
+    messageTemplate?: string;
+    identifiers?: PersonIdentifiers;
+}
+export declare enum ConvergePipelineLoggableActivityType {
+    Generic = "generic",
+    ActivityIngress = "activityIngress",
+    ActivityEgress = "activityEgress",
+    UserProfile = "userProfile",
+    SdkLog = "sdkLog",
+    Detections = "detections",
+    ActivityEgressFilter = "activityEgressFilter",
+    Diagnosis = "diagnosis",
+    PipelineIntegrationOutput = "pipelineIntegrationOutput"
+}
+export declare enum SdkLogEventLevel {
+    Information = "information",
+    Warning = "warning",
+    Error = "error",
+    Verbose = "verbose"
+}
+export declare enum SeekaWebhookCallType {
+    None = "none",
+    Probe = "probe",
+    AppInstalled = "appInstalled",
+    IdentityChanged = "identityChanged",
+    ActivityAccepted = "activityAccepted",
+    AppInstallSettingsUpdated = "appInstallSettingsUpdated",
+    AppUninstalled = "appUninstalled"
+}
+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;
+}
+export interface SeekaProbeWebhookPayload {
+    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;
+}
+export interface SeekaWebhookPayloadOfSeekaAppWebhookContext extends SeekaWebhookPayload {
+    context?: SeekaAppWebhookContext;
+}
+export interface SeekaWebhookPayloadOfSeekaAppWebhookContextAndSeekaAppInstalledWebhookContent extends SeekaWebhookPayloadOfSeekaAppWebhookContext {
+    content?: SeekaAppInstalledWebhookContent | undefined;
+}
+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 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 SeekaAppInstalledWebhookPayload extends SeekaWebhookPayloadOfSeekaAppWebhookContext {
+    content?: SeekaAppInstalledWebhookContent | undefined;
+}
+export interface SeekaWebhookPayloadOfSeekaAppWebhookContextAndSeekaAppUninstalledWebhookContent extends SeekaWebhookPayloadOfSeekaAppWebhookContext {
+    content?: SeekaAppUninstalledWebhookContent | undefined;
+}
+export interface SeekaAppUninstalledWebhookContent {
+    installationSettings?: {
+        [key: string]: any;
+    };
+}
+export interface SeekaAppUninstalledWebhookPayload extends SeekaWebhookPayloadOfSeekaAppWebhookContext {
+    content?: SeekaAppUninstalledWebhookContent | undefined;
+}
+export interface SeekaWebhookPayloadOfSeekaAppWebhookContextAndSeekaAppInstallSettingsUpdatedWebhookContent extends SeekaWebhookPayloadOfSeekaAppWebhookContext {
+    content?: SeekaAppInstallSettingsUpdatedWebhookContent | undefined;
+}
+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 {
+    content?: SeekaAppInstallSettingsUpdatedWebhookContent | undefined;
+}
+export interface SeekaWebhookPayloadOfSeekaAppWebhookContextAndSeekaActivityAcceptedWebhookContent extends SeekaWebhookPayloadOfSeekaAppWebhookContext {
+    content?: SeekaActivityAcceptedWebhookContent | undefined;
+}
+export interface SeekaActivityAcceptedWebhookContent {
+    source?: TrackingEventSource;
+    identifiers?: PersonIdentifiers;
+    activity?: ActivityPayload2;
+    personId?: string;
+}
+export interface ActivityPayload2 extends ActivityPayloadBase {
+    /** Time activity occurred */
+    time?: Date;
+}
+export interface SeekaActivityAcceptedWebhookPayload extends SeekaWebhookPayloadOfSeekaAppWebhookContext {
+    content?: SeekaActivityAcceptedWebhookContent | undefined;
+}
+export interface SeekaWebhookPayloadOfSeekaAppWebhookContextAndSeekaIdentityChangedWebhookContent extends SeekaWebhookPayloadOfSeekaAppWebhookContext {
+    content?: SeekaIdentityChangedWebhookContent | undefined;
+}
+export interface SeekaIdentityChangedWebhookContent {
+    identifiers?: PersonIdentifiers;
+    personId?: string;
+}
+export interface SeekaIdentityChangedWebhookPayload extends SeekaWebhookPayloadOfSeekaAppWebhookContext {
+    content?: SeekaIdentityChangedWebhookContent | undefined;
+}
+export declare class ApiException extends Error {
+    message: string;
+    status: number;
+    response: string;
+    headers: {
+        [key: string]: any;
+    };
+    result: any;
+    constructor(message: string, status: number, response: string, headers: {
+        [key: string]: any;
+    }, result: any);
+    protected isApiException: boolean;
+    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;
+}
+//# sourceMappingURL=index.d.ts.map