From a023f1d770818206fb859f25caba8ef014719e16 Mon Sep 17 00:00:00 2001 From: github-actions Date: Fri, 19 Apr 2024 14:04:32 +0000 Subject: [PATCH] Generated docs for a2a1fe3cd960df6dbf3950008a8102ab4edd9b4f --- docs/enums/EventName.html | 10 +++---- docs/enums/ProfileProperty.html | 40 +++++++++++++-------------- docs/interfaces/Event.html | 10 +++---- docs/interfaces/KlaviyoInterface.html | 28 +++++++++---------- docs/interfaces/Location.html | 20 +++++++------- docs/interfaces/Profile.html | 22 +++++++-------- docs/types/EventProperties.html | 2 +- docs/types/ProfileProperties.html | 2 +- docs/types/ProfilePropertyKey.html | 2 +- docs/variables/Klaviyo.html | 2 +- 10 files changed, 69 insertions(+), 69 deletions(-) diff --git a/docs/enums/EventName.html b/docs/enums/EventName.html index dcd4a35..5c73ca1 100644 --- a/docs/enums/EventName.html +++ b/docs/enums/EventName.html @@ -1,10 +1,10 @@ EventName | klaviyo-react-native-sdk

Enumeration EventName

EventName is a convenience enum for the names of common events that can be tracked.

-

Enumeration Members

ADDED_TO_CART_METRIC +

Enumeration Members

ADDED_TO_CART_METRIC OPENED_APP_METRIC STARTED_CHECKOUT_METRIC VIEWED_PRODUCT_METRIC

Enumeration Members

ADDED_TO_CART_METRIC

ADDED_TO_CART_METRIC: number

The 'Added to Cart' event is used to track when a user adds a product to their cart.

-

OPENED_APP_METRIC

OPENED_APP_METRIC: number

The 'Opened App' event is used to track when a user opens the app.

-

STARTED_CHECKOUT_METRIC

STARTED_CHECKOUT_METRIC: number

The 'Started Checkout' event is used to track when a user starts the checkout process.

-

VIEWED_PRODUCT_METRIC

VIEWED_PRODUCT_METRIC: number

The 'Viewed Product' event is used to track when a user views a product.

-

Settings

Member Visibility

Theme

On This Page

ADDED_TO_CART_METRICOPENED_APP_METRICSTARTED_CHECKOUT_METRICVIEWED_PRODUCT_METRIC

Generated using TypeDoc

\ No newline at end of file +

OPENED_APP_METRIC

OPENED_APP_METRIC: number

The 'Opened App' event is used to track when a user opens the app.

+

STARTED_CHECKOUT_METRIC

STARTED_CHECKOUT_METRIC: number

The 'Started Checkout' event is used to track when a user starts the checkout process.

+

VIEWED_PRODUCT_METRIC

VIEWED_PRODUCT_METRIC: number

The 'Viewed Product' event is used to track when a user views a product.

+

Settings

Member Visibility

Theme

On This Page

ADDED_TO_CART_METRICOPENED_APP_METRICSTARTED_CHECKOUT_METRICVIEWED_PRODUCT_METRIC

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/ProfileProperty.html b/docs/enums/ProfileProperty.html index 8286712..bd01d51 100644 --- a/docs/enums/ProfileProperty.html +++ b/docs/enums/ProfileProperty.html @@ -1,5 +1,5 @@ ProfileProperty | klaviyo-react-native-sdk

Enumeration ProfileProperty

Enum for various profile properties that can be set on a user

-

Enumeration Members

ADDRESS1 +

Enumeration Members

ADDRESS1 ADDRESS2 CITY COUNTRY @@ -19,25 +19,25 @@ TITLE ZIP

Enumeration Members

ADDRESS1

ADDRESS1: number

First line of street address

-

ADDRESS2

ADDRESS2: number

Second line of street address

-

CITY

CITY: number

City name

-

COUNTRY

COUNTRY: number

Country name

-

EMAIL

EMAIL: number

Individual's email address

+

ADDRESS2

ADDRESS2: number

Second line of street address

+

CITY

CITY: number

City name

+

COUNTRY

COUNTRY: number

Country name

+

EMAIL

EMAIL: number

Individual's email address

Deprecated

Setting identifiers via setProfileAttribute is deprecated, and this enum will be removed in an upcoming release. Use the corresponding setter function instead.

-

EXTERNAL_ID

EXTERNAL_ID: number

A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.

+

EXTERNAL_ID

EXTERNAL_ID: number

A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.

Deprecated

Setting identifiers via setProfileAttribute is deprecated, and this enum will be removed in an upcoming release. Use the corresponding setter function instead.

-

FIRST_NAME

FIRST_NAME: number

Individual's first name

-

IMAGE

IMAGE: number

URL pointing to the location of a profile image

-

LAST_NAME

LAST_NAME: number

Individual's last name

-

LATITUDE

LATITUDE: number

Latitude coordinate. We recommend providing a precision of four decimal places.

-

LOCATION

LOCATION: number

An object containing location information for this profile

-

LONGITUDE

LONGITUDE: number

Longitude coordinate. We recommend providing a precision of four decimal places.

-

ORGANIZATION

ORGANIZATION: number

Name of the company or organization within the company for whom the individual works

-

PHONE_NUMBER

PHONE_NUMBER: number

Individual's phone number in E.164 format

+

FIRST_NAME

FIRST_NAME: number

Individual's first name

+

IMAGE

IMAGE: number

URL pointing to the location of a profile image

+

LAST_NAME

LAST_NAME: number

Individual's last name

+

LATITUDE

LATITUDE: number

Latitude coordinate. We recommend providing a precision of four decimal places.

+

LOCATION

LOCATION: number

An object containing location information for this profile

+

LONGITUDE

LONGITUDE: number

Longitude coordinate. We recommend providing a precision of four decimal places.

+

ORGANIZATION

ORGANIZATION: number

Name of the company or organization within the company for whom the individual works

+

PHONE_NUMBER

PHONE_NUMBER: number

Individual's phone number in E.164 format

Deprecated

Setting identifiers via setProfileAttribute is deprecated, and this enum will be removed in an upcoming release. Use the corresponding setter function instead.

-

PROPERTIES

PROPERTIES: number

An object containing key/value pairs for any custom properties assigned to this profile

-

REGION

REGION: number

Region within a country, such as state or province

-

TIMEZONE

TIMEZONE: number

Time zone name. We recommend using time zones from the IANA Time Zone Database.

-

TITLE

TITLE: number

Individual's job title

-

ZIP

ZIP: number

Zip code

-

Settings

Member Visibility

Theme

On This Page

ADDRESS1ADDRESS2CITYCOUNTRYEMAILEXTERNAL_IDFIRST_NAMEIMAGELAST_NAMELATITUDELOCATIONLONGITUDEORGANIZATIONPHONE_NUMBERPROPERTIESREGIONTIMEZONETITLEZIP

Generated using TypeDoc

\ No newline at end of file +

PROPERTIES

PROPERTIES: number

An object containing key/value pairs for any custom properties assigned to this profile

+

REGION

REGION: number

Region within a country, such as state or province

+

TIMEZONE

TIMEZONE: number

Time zone name. We recommend using time zones from the IANA Time Zone Database.

+

TITLE

TITLE: number

Individual's job title

+

ZIP

ZIP: number

Zip code

+

Settings

Member Visibility

Theme

On This Page

ADDRESS1ADDRESS2CITYCOUNTRYEMAILEXTERNAL_IDFIRST_NAMEIMAGELAST_NAMELATITUDELOCATIONLONGITUDEORGANIZATIONPHONE_NUMBERPROPERTIESREGIONTIMEZONETITLEZIP

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Event.html b/docs/interfaces/Event.html index 60bd903..cd96bac 100644 --- a/docs/interfaces/Event.html +++ b/docs/interfaces/Event.html @@ -1,19 +1,19 @@ Event | klaviyo-react-native-sdk

Interface Event

Interface for an event

-
interface Event {
    name: string | EventName;
    properties?: EventProperties;
    uniqueId?: string;
    value?: number;
}

Properties

name +
interface Event {
    name: string | EventName;
    properties?: EventProperties;
    uniqueId?: string;
    value?: number;
}

Properties

name properties? uniqueId? value?

Properties

Readonly name

name: string | EventName

Name of the event. Must be less than 128 characters.

-

Optional Readonly properties

properties?: EventProperties

Properties of this event. Any top level property (that are not objects) can be +

Optional Readonly properties

properties?: EventProperties

Properties of this event. Any top level property (that are not objects) can be used to create segments. The $extra property is a special property. This records any non-segmentable values that can be referenced later. For example, HTML templates are useful on a segment but are not used to create a segment. There are limits placed onto the size of the data present. This must not exceed 5 MB. This must not exceed 300 event properties. A single string cannot be larger than 100 KB. Each array must not exceed 4000 elements. The properties cannot contain more than 10 nested levels.

-

Optional Readonly uniqueId

uniqueId?: string

A unique identifier for an event. If the uniqueId is repeated for the same +

Optional Readonly uniqueId

uniqueId?: string

A unique identifier for an event. If the uniqueId is repeated for the same profile and metric, only the first processed event will be recorded. If this is not present, this will use the time to the second. Using the default, this limits only one event per profile per second.

-

Optional Readonly value

value?: number

A numeric value to associate with this event. For example, the dollar amount of a purchase.

-

Settings

Member Visibility

Theme

On This Page

namepropertiesuniqueIdvalue

Generated using TypeDoc

\ No newline at end of file +

Optional Readonly value

value?: number

A numeric value to associate with this event. For example, the dollar amount of a purchase.

+

Settings

Member Visibility

Theme

On This Page

namepropertiesuniqueIdvalue

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/KlaviyoInterface.html b/docs/interfaces/KlaviyoInterface.html index b34f1ba..38cef78 100644 --- a/docs/interfaces/KlaviyoInterface.html +++ b/docs/interfaces/KlaviyoInterface.html @@ -1,7 +1,7 @@ KlaviyoInterface | klaviyo-react-native-sdk

Interface KlaviyoInterface

The Klaviyo React Native SDK Interface

This interface extends the KlaviyoEventAPI and KlaviyoProfileApi interfaces, providing a unified API for interacting with Klaviyo's event tracking and profile management features.

-
interface KlaviyoInterface {
    createEvent(event): void;
    getEmail(callback): null | String;
    getExternalId(callback): null | String;
    getPhoneNumber(callback): null | String;
    getPushToken(callback): null | String;
    initialize(apiKey): void;
    resetProfile(): void;
    setEmail(email): void;
    setExternalId(externalId): void;
    setPhoneNumber(phoneNumber): void;
    setProfile(profile): void;
    setProfileAttribute(propertyKey, value): void;
    setPushToken(token): void;
}

Hierarchy

  • KlaviyoEventAPI
  • KlaviyoProfileApi
  • KlaviyoPushApi
    • KlaviyoInterface

Methods

createEvent +
interface KlaviyoInterface {
    createEvent(event): void;
    getEmail(callback): null | String;
    getExternalId(callback): null | String;
    getPhoneNumber(callback): null | String;
    getPushToken(callback): null | String;
    initialize(apiKey): void;
    resetProfile(): void;
    setEmail(email): void;
    setExternalId(externalId): void;
    setPhoneNumber(phoneNumber): void;
    setProfile(profile): void;
    setProfileAttribute(propertyKey, value): void;
    setPushToken(token): void;
}

Hierarchy

  • KlaviyoEventAPI
  • KlaviyoProfileApi
  • KlaviyoPushApi
    • KlaviyoInterface

Methods

createEvent getEmail getExternalId getPhoneNumber @@ -16,26 +16,26 @@ setPushToken

Methods

createEvent

  • createEvent(event): void

  • Create a new event to track a profile's activity.

    Parameters

    • event: Event

      The event to track

      -

    Returns void

getEmail

  • getEmail(callback): null | String

  • Retrieve a profile's email address.

    +

Returns void

getEmail

  • getEmail(callback): null | String

  • Retrieve a profile's email address.

    Parameters

    • callback: undefined | Function

      The callback function to handle the response

      -

    Returns null | String

getExternalId

  • getExternalId(callback): null | String

  • Retrieve a profile's external ID.

    +

Returns null | String

getExternalId

  • getExternalId(callback): null | String

  • Retrieve a profile's external ID.

    Parameters

    • callback: undefined | Function

      The callback function to handle the response

      -

    Returns null | String

getPhoneNumber

  • getPhoneNumber(callback): null | String

  • Retrieve a profile's phone number.

    +

Returns null | String

getPhoneNumber

getPushToken

initialize

Returns null | String

getPushToken

initialize

resetProfile

setEmail

Returns void

resetProfile

setEmail

setExternalId

Returns void

setExternalId

setPhoneNumber

Returns void

setPhoneNumber

setProfile

Returns void

setProfile

setProfileAttribute

Returns void

setProfileAttribute

setPushToken

Settings

Member Visibility

Theme

On This Page

createEventgetEmailgetExternalIdgetPhoneNumbergetPushTokeninitializeresetProfilesetEmailsetExternalIdsetPhoneNumbersetProfilesetProfileAttributesetPushToken

Generated using TypeDoc

\ No newline at end of file +

Returns void

setPushToken

Settings

Member Visibility

Theme

On This Page

createEventgetEmailgetExternalIdgetPhoneNumbergetPushTokeninitializeresetProfilesetEmailsetExternalIdsetPhoneNumbersetProfilesetProfileAttributesetPushToken

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Location.html b/docs/interfaces/Location.html index 191b124..ec532b0 100644 --- a/docs/interfaces/Location.html +++ b/docs/interfaces/Location.html @@ -1,5 +1,5 @@ Location | klaviyo-react-native-sdk

Interface Location

Interface for location information of a profile

-
interface Location {
    address1?: string;
    address2?: string;
    city?: string;
    country?: string;
    latitude?: number;
    longitude?: number;
    region?: string;
    timezone?: string;
    zip?: string;
}

Properties

address1? +
interface Location {
    address1?: string;
    address2?: string;
    city?: string;
    country?: string;
    latitude?: number;
    longitude?: number;
    region?: string;
    timezone?: string;
    zip?: string;
}

Properties

address1? address2? city? country? @@ -9,12 +9,12 @@ timezone? zip?

Properties

Optional Readonly address1

address1?: string

First line of street address

-

Optional Readonly address2

address2?: string

Second line of street address

-

Optional Readonly city

city?: string

City name

-

Optional Readonly country

country?: string

Country name

-

Optional Readonly latitude

latitude?: number

Latitude coordinate. We recommend providing a precision of four decimal places.

-

Optional Readonly longitude

longitude?: number

Longitude coordinate. We recommend providing a precision of four decimal places.

-

Optional Readonly region

region?: string

Region within a country, such as state or province

-

Optional Readonly timezone

timezone?: string

Time zone name. We recommend using time zones from the IANA Time Zone Database.

-

Optional Readonly zip

zip?: string

Zip code

-

Settings

Member Visibility

Theme

On This Page

address1address2citycountrylatitudelongituderegiontimezonezip

Generated using TypeDoc

\ No newline at end of file +

Optional Readonly address2

address2?: string

Second line of street address

+

Optional Readonly city

city?: string

City name

+

Optional Readonly country

country?: string

Country name

+

Optional Readonly latitude

latitude?: number

Latitude coordinate. We recommend providing a precision of four decimal places.

+

Optional Readonly longitude

longitude?: number

Longitude coordinate. We recommend providing a precision of four decimal places.

+

Optional Readonly region

region?: string

Region within a country, such as state or province

+

Optional Readonly timezone

timezone?: string

Time zone name. We recommend using time zones from the IANA Time Zone Database.

+

Optional Readonly zip

zip?: string

Zip code

+

Settings

Member Visibility

Theme

On This Page

address1address2citycountrylatitudelongituderegiontimezonezip

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Profile.html b/docs/interfaces/Profile.html index 70243a3..e910c1c 100644 --- a/docs/interfaces/Profile.html +++ b/docs/interfaces/Profile.html @@ -1,5 +1,5 @@ Profile | klaviyo-react-native-sdk

Interface Profile

Interface for a profile

-
interface Profile {
    email?: string;
    externalId?: string;
    firstName?: string;
    image?: string;
    lastName?: string;
    location?: Location;
    organization?: string;
    phoneNumber?: string;
    properties?: ProfileProperties;
    title?: string;
}

Properties

email? +
interface Profile {
    email?: string;
    externalId?: string;
    firstName?: string;
    image?: string;
    lastName?: string;
    location?: Location;
    organization?: string;
    phoneNumber?: string;
    properties?: ProfileProperties;
    title?: string;
}

Properties

email? externalId? firstName? image? @@ -10,13 +10,13 @@ properties? title?

Properties

Optional Readonly email

email?: string

Individual's email address

-

Optional Readonly externalId

externalId?: string

A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.

-

Optional Readonly firstName

firstName?: string

Individual's first name

-

Optional Readonly image

image?: string

URL pointing to the location of a profile image

-

Optional Readonly lastName

lastName?: string

Individual's last name

-

Optional Readonly location

location?: Location

An object containing location information for this profile

-

Optional Readonly organization

organization?: string

Name of the company or organization within the company for whom the individual works

-

Optional Readonly phoneNumber

phoneNumber?: string

Individual's phone number in E.164 format

-

Optional Readonly properties

properties?: ProfileProperties

An object containing key/value pairs for any custom properties assigned to this profile

-

Optional Readonly title

title?: string

Individual's job title

-

Settings

Member Visibility

Theme

On This Page

emailexternalIdfirstNameimagelastNamelocationorganizationphoneNumberpropertiestitle

Generated using TypeDoc

\ No newline at end of file +

Optional Readonly externalId

externalId?: string

A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.

+

Optional Readonly firstName

firstName?: string

Individual's first name

+

Optional Readonly image

image?: string

URL pointing to the location of a profile image

+

Optional Readonly lastName

lastName?: string

Individual's last name

+

Optional Readonly location

location?: Location

An object containing location information for this profile

+

Optional Readonly organization

organization?: string

Name of the company or organization within the company for whom the individual works

+

Optional Readonly phoneNumber

phoneNumber?: string

Individual's phone number in E.164 format

+

Optional Readonly properties

properties?: ProfileProperties

An object containing key/value pairs for any custom properties assigned to this profile

+

Optional Readonly title

title?: string

Individual's job title

+

Settings

Member Visibility

Theme

On This Page

emailexternalIdfirstNameimagelastNamelocationorganizationphoneNumberpropertiestitle

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/EventProperties.html b/docs/types/EventProperties.html index 5eb13a1..1ad4ce9 100644 --- a/docs/types/EventProperties.html +++ b/docs/types/EventProperties.html @@ -1,2 +1,2 @@ EventProperties | klaviyo-react-native-sdk

Type alias EventProperties

EventProperties: Record<string, Object>

Type for event properties

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/ProfileProperties.html b/docs/types/ProfileProperties.html index 3bf5011..b8eaf6e 100644 --- a/docs/types/ProfileProperties.html +++ b/docs/types/ProfileProperties.html @@ -1,2 +1,2 @@ ProfileProperties | klaviyo-react-native-sdk

Type alias ProfileProperties

ProfileProperties: Record<ProfilePropertyKey, Object>

Type for profile properties

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/ProfilePropertyKey.html b/docs/types/ProfilePropertyKey.html index 08ec5bb..7ef915e 100644 --- a/docs/types/ProfilePropertyKey.html +++ b/docs/types/ProfilePropertyKey.html @@ -1,2 +1,2 @@ ProfilePropertyKey | klaviyo-react-native-sdk

Type alias ProfilePropertyKey

ProfilePropertyKey: ProfileProperty | string

Type for a profile property key

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/Klaviyo.html b/docs/variables/Klaviyo.html index 0ff0ada..31d3109 100644 --- a/docs/variables/Klaviyo.html +++ b/docs/variables/Klaviyo.html @@ -1,2 +1,2 @@ Klaviyo | klaviyo-react-native-sdk

Variable KlaviyoConst

Klaviyo: Spec = ...

Implementation of the KlaviyoInterface

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file