Evergage Core API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Modules

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

AccessTokenRequestMethod

AccessTokenRequestMethod: "POST" | "GET"

AccessTokenResponseFormat

AccessTokenResponseFormat: "Json" | "UrlFormEncoded"

ActionTriggerType

ActionTriggerType: "EventAction"

AttributeType

AttributeType: "String" | "Integer" | "Decimal" | "Date" | "Boolean" | "Object" | "MultiString" | "Html"

AttributeValue

AttributeValue: string | number | boolean | Date | null | AttributeValueObject | AttributeValueArray

AuthenticationType

AuthenticationType: "HttpBasic" | "OAuth" | "Custom"

BodyEncoding

BodyEncoding: "Text" | "Json" | "MultipartForm" | "UrlEncodedForm"

Browser

Browser: "Chrome" | "Firefox" | "Safari" | "Internet Explorer" | "Other" | "Unknown"

CampaignAction

CampaignAction: "View" | "Click" | "Dismiss" | "Send" | "Unsubscribe" | "Open"

CampaignType

CampaignType: "Web" | "Email"

CatalogTriggerType

CatalogTriggerType: "CartAbandonment" | "BrowseAbandonment" | "NewItemInFavoriteCategory" | "ProductBackInStock" | "ProductExpiringSoon" | "ProductLowInventory" | "ProductPriceReduction"

Classification

Classification: "Sensitive" | "PersonallyIdentifiable" | "NonSensitive"

ClientAuthentication

ClientAuthentication: "HttpBasicAuthentication" | "RequestBodyUrlEncoded"

CustomerIdentitySource

CustomerIdentitySource: "Anonymous" | "CRM" | "Login" | "ESP" | "ETL" | "API" | "Device" | "Other"

CustomerIdentityType

CustomerIdentityType: "Email" | "UniqueId"

DeviceType

DeviceType: "Mobile" | "Tablet" | "Computer" | "Other" | "Unknown"

EmailContentType

EmailContentType: "Plaintext" | "Html"

EmailSuppressionReason

EmailSuppressionReason: "Complaint" | "PermanentBounce" | "Unsubscribe" | "Unknown"

EmailType

EmailType: "Triggered" | "Batch"

EtlTimeSource

EtlTimeSource: "ProcessingTime" | "FileName" | "FileContent"

The source of a timestamp corresponding to an ETL object.

GearErrorCode

GearErrorCode: "UNKNOWN_ERROR" | "MISSING_CONFIGURATION" | "MISSING_REQUIRED_CONFIG_FIELD" | "MISSING_SYSTEM_FIELD" | "MISSING_USER_FIELD" | "API_QUOTA_ERROR" | "API_AUTHORIZATION_ERROR" | "MISSING_API_REQUIRED_FIELD" | "NETWORK_ERROR" | "API_ERROR" | "API_OBJECT_CONFLICT" | "API_OBJECT_NOT_FOUND" | "API_INCORRECT_DATA_TYPE" | "API_INVALID_FIELD_LENGTH"

Well-known error codes

GearResult

GearResult: object | object

Represents a return value from a Gear function that has a return value OR error information.

GearRuleEnvironment

GearRuleEnvironment: "Segment" | "AccountSegment" | "UserSegment" | "Campaign" | "Promotion"

ImageType

ImageType: "gif" | "jpeg" | "png"

ImportanceScore

ImportanceScore: "A" | "B" | "C"

ItemStatType

ItemStatType: "View" | "ViewOutOfStock" | "ViewValue" | "ViewDetail" | "QuickView" | "ViewTime" | "Cart" | "CartValue" | "Purchase" | "Visit" | "PurchaseValue" | "Review" | "Share" | "Comment" | "Favorite" | "Searches" | "SearchClicks" | "ClickThrough" | "RemoveFromCart" | "RemoveFromCartValue" | "RecommendedCount" | "PageLoadTime" | "PageLoadTimeCount" | "DomLoadTime" | "DomLoadTimeCount" | "TwReceiverTime" | "TwReceiverTimeCount" | "NumErrorEvents" | "TriggeredCount" | "RequestedForServing" | "EligibleForServing" | "Served"

OAuthMode

OAuthMode: "UserContext" | "ServiceContext"

Somewhat Customer friendly version of https://oauth.net/2/grant-types/

OperatingSystem

OperatingSystem: "Linux" | "Windows" | "Mac OS X" | "Android" | "iOS" | "Other" | "Unknown"

Option

Option: HasLabel | string | number

Platform

Platform: "Web" | "Mobile App" | "Email" | "In Store"

ResolvedAnswer

ResolvedAnswer: "ResolvedToOne" | "ResolvedAmbiguously" | "FailedToResolve" | "NotFound"

Declares the result of a user conflict resolution.

SegmentTriggerType

SegmentTriggerType: "SegmentJoin" | "SegmentLeave"

TokenUsage

TokenUsage: "BearerAuthorizationHeader" | "BearerFormEncodedBodyParameter" | "BearerUriQueryParameter" | "Facebook"

ValidationResults

ValidationResults: ValidationResults<T>

WeatherCategory

WeatherCategory: "Thunderstorm" | "Drizzle" | "Rain" | "Atmosphere" | "Snow" | "Clouds" | "Clear" | "Extreme" | "Additional" | "Unknown"

WorkflowActionResultStatus

WorkflowActionResultStatus: "Succeeded" | "Cancelled" | "Retry"

Status for a particular User.

Variables

button

button: function

Type declaration

    • (value: string): function

buttonGroup

buttonGroup: function

Type declaration

    • (value: boolean | void): function

    • Parameters

      • value: boolean | void

      Returns function

cached

cached: function

Type declaration

    • (value: string): function

createable

createable: function

Type declaration

    • (value: boolean): function

description

description: function

Type declaration

    • (value: string): function

getButton

getButton: function

Type declaration

    • (target: any, propertyKey: string): string

    • Parameters

      • target: any
      • propertyKey: string

      Returns string

getButtonGroup

getButtonGroup: function

Type declaration

    • (target: any, propertyKey: string): boolean | void

    • Parameters

      • target: any
      • propertyKey: string

      Returns boolean | void

getCached

getCached: function

Type declaration

    • (target: any, propertyKey: string): string

    • Parameters

      • target: any
      • propertyKey: string

      Returns string

getCreateable

getCreateable: function

Type declaration

    • (target: any, propertyKey: string): boolean

    • Parameters

      • target: any
      • propertyKey: string

      Returns boolean

getDescription

getDescription: function

Type declaration

    • (target: any, propertyKey: string): string

    • Parameters

      • target: any
      • propertyKey: string

      Returns string

getHeader

getHeader: function

Type declaration

    • (target: any, propertyKey: string): string

    • Parameters

      • target: any
      • propertyKey: string

      Returns string

getHeaderSubtitle

getHeaderSubtitle: function

Type declaration

    • (target: any, propertyKey: string): string

    • Parameters

      • target: any
      • propertyKey: string

      Returns string

getMarkdown

getMarkdown: function

Type declaration

    • (target: any, propertyKey: string): string

    • Parameters

      • target: any
      • propertyKey: string

      Returns string

getOptional

getOptional: function

Type declaration

    • (target: any, propertyKey: string): boolean | void

    • Parameters

      • target: any
      • propertyKey: string

      Returns boolean | void

getRange

getRange: function

Type declaration

    • (target: any, propertyKey: string): boolean

    • Parameters

      • target: any
      • propertyKey: string

      Returns boolean

getRichText

getRichText: function

Type declaration

    • (target: any, propertyKey: string): boolean | void

    • Parameters

      • target: any
      • propertyKey: string

      Returns boolean | void

getSecret

getSecret: function

Type declaration

    • (target: any, propertyKey: string): boolean | void

    • Parameters

      • target: any
      • propertyKey: string

      Returns boolean | void

getSubtitle

getSubtitle: function

Type declaration

    • (target: any, propertyKey: string): string

    • Parameters

      • target: any
      • propertyKey: string

      Returns string

getTitle

getTitle: function

Type declaration

    • (target: any, propertyKey: string): string

    • Parameters

      • target: any
      • propertyKey: string

      Returns string

getUnits

getUnits: function

Type declaration

    • (target: any, propertyKey: string): string

    • Parameters

      • target: any
      • propertyKey: string

      Returns string

Const globalAny

globalAny: any

Const groupKey

groupKey: keyof symbol

header

header: function

Type declaration

    • (value: string): function

headerSubtitle

headerSubtitle: function

Type declaration

    • (value: string): function

Const hiddenKey

hiddenKey: keyof symbol

Const layoutKey

layoutKey: keyof symbol

Const lookupOptionsKey

lookupOptionsKey: keyof symbol

markdown

markdown: function

Type declaration

    • (value: string): function

optional

optional: function

Type declaration

    • (value: boolean | void): function

    • Parameters

      • value: boolean | void

      Returns function

Const optionsKey

optionsKey: keyof symbol

Const placeholderKey

placeholderKey: keyof symbol

range

range: function

Type declaration

    • (value: boolean): function

richText

richText: function

Type declaration

    • (value: boolean | void): function

    • Parameters

      • value: boolean | void

      Returns function

Const searchOptionsKey

searchOptionsKey: keyof symbol

secret

secret: function

Type declaration

    • (value: boolean | void): function

    • Parameters

      • value: boolean | void

      Returns function

Const shownIfKey

shownIfKey: keyof symbol

subtitle

subtitle: function

Type declaration

    • (value: string): function

Const tabularKey

tabularKey: keyof symbol

title

title: function

Type declaration

    • (value: string): function

units

units: function

Type declaration

    • (value: string): function

Functions

getGroup

  • getGroup<T>(target: T, propertyKey: string): Array<T>

  • Type parameters

    • T

    Parameters

    • target: T
    • propertyKey: string

    Returns Array<T>

getHidden

  • getHidden(target: any, propertyKey: string): boolean

  • Parameters

    • target: any
    • propertyKey: string

    Returns boolean

getLayout

  • getLayout<T>(target: T, propertyKey: string): Array<T>

  • Type parameters

    • T

    Parameters

    • target: T
    • propertyKey: string

    Returns Array<T>

getLookupOptions

  • getLookupOptions<T>(target: T, rootComponent: any, propertyKey: string): Array<T>

  • Type parameters

    • T

    Parameters

    • target: T
    • rootComponent: any
    • propertyKey: string

    Returns Array<T>

getOptions

  • getOptions<T>(target: T, propertyKey: string): Array<T>

  • Type parameters

    • T

    Parameters

    • target: T
    • propertyKey: string

    Returns Array<T>

getPlaceholder

  • getPlaceholder(target: any, propertyKey: string): boolean

  • Parameters

    • target: any
    • propertyKey: string

    Returns boolean

getSearchOptions

  • getSearchOptions<T>(target: T, rootComponent: any, propertyKey: string): Array<T>

  • Type parameters

    • T

    Parameters

    • target: T
    • rootComponent: any
    • propertyKey: string

    Returns Array<T>

getShownIf

  • getShownIf(target: any, propertyKey: string): boolean

  • Parameters

    • target: any
    • propertyKey: string

    Returns boolean

getTabular

  • getTabular<T>(target: T, propertyKey: string): Array<T>

  • Type parameters

    • T

    Parameters

    • target: T
    • propertyKey: string

    Returns Array<T>

group

hidden

  • hidden<T>(value: boolean): any
  • hidden<T>(thisClass: T, shouldHide: function): any

  • Type parameters

    • T

    Parameters

    • value: boolean

    Returns any

  • Type parameters

    • T

    Parameters

    • thisClass: T
    • shouldHide: function
        • (self: T): boolean

        • Parameters

          • self: T

          Returns boolean

    Returns any

layout

lookupOptions

  • lookupOptions<T, RT>(lookup: T): function

  • Type parameters

    Parameters

    • lookup: T

    Returns function

      • <ST, K>(target: ST, propertyKey: K): void

      • Type parameters

        • ST: object

        • K: keyof ST | string

        Parameters

        • target: ST
        • propertyKey: K

        Returns void

options

  • options<T>(value: Array<T>): function

  • Type parameters

    Parameters

    • value: Array<T>

    Returns function

placeholder

  • placeholder<T>(value: string): any
  • placeholder<T>(thisClass: T, placeholder: function): any

  • Type parameters

    • T

    Parameters

    • value: string

    Returns any

  • Type parameters

    • T

    Parameters

    • thisClass: T
    • placeholder: function
        • (self: T): string

        • Parameters

          • self: T

          Returns string

    Returns any

searchOptions

  • searchOptions<T, RT>(search: T): function

  • Type parameters

    Parameters

    • search: T

    Returns function

      • <ST, K>(target: ST, propertyKey: K): void

      • Type parameters

        • ST: object

        • K: keyof ST | string

        Parameters

        • target: ST
        • propertyKey: K

        Returns void

shownIf

  • shownIf<T>(value: boolean): any
  • shownIf<T>(thisClass: T, shouldHide: function): any

  • Type parameters

    • T

    Parameters

    • value: boolean

    Returns any

  • Type parameters

    • T

    Parameters

    • thisClass: T
    • shouldHide: function
        • (self: T): boolean

        • Parameters

          • self: T

          Returns boolean

    Returns any

tabular

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc