Class NotifiFrontendClient

Constructors

constructor

Accessors

auth userState

Methods

addEventListener alterTargetGroup beginLoginViaTransaction completeLoginViaTransaction createDiscordTarget createWebPushTarget deleteAlert deleteAlerts deleteWebPushTarget ensureFusionAlerts ensureTargetGroup fetchFusionData fetchTenantConfig getAlerts getFusionNotificationHistory getTargetGroups getUnreadNotificationHistoryCount getUserSettings getWebPushTargets initialize logIn logOut markFusionNotificationHistoryAsRead removeEventListener renewTargetGroup sendEmailTargetVerification updateUserSettings updateWebPushTarget verifyCbwTarget verifyXmtpTargetViaXip42

Constructors

constructor

Accessors

auth

  • get auth(): AuthManager

  • Returns AuthManager

userState

  • get userState(): null | UserState

  • Returns null | UserState

    Deprecated

    Use frontendClient.auth.userState instead

Methods

addEventListener

  • addEventListener<K>(event, callBack, onError?, onCompleted?): string

  • Type Parameters

    • K extends keyof NotifiSubscriptionEvents

    Parameters

    • event: K
    • callBack: ((...args: NotifiSubscriptionEvents[K]) => void)
        • (...args): void

        • Parameters

          • Rest...args: NotifiSubscriptionEvents[K]

          Returns void

    • OptionalonError: ((error: unknown) => void)
        • (error): void

        • Parameters

          • error: unknown

          Returns void

    • OptionalonCompleted: (() => void)
        • (): void

        • Returns void

    Returns string

    • The id of the event listener (used to remove the event listener)

alterTargetGroup

  • alterTargetGroup(alterTargetGroupParams): Promise<TargetGroupFragmentFragment>

  • Parameters

    • alterTargetGroupParams: Readonly<{
          name: string;
      } & Partial<Record<NotifiTarget, UpdateTargetsParam>>>

    Returns Promise<TargetGroupFragmentFragment>

beginLoginViaTransaction

  • beginLoginViaTransaction(props): Promise<BeginLogInByTransactionResult>

  • Parameters

    • props: BeginLoginProps

    Returns Promise<BeginLogInByTransactionResult>

    Deprecated

    Use frontendClient.auth.beginLoginViaTransaction instead

completeLoginViaTransaction

  • completeLoginViaTransaction(props): Promise<CompleteLogInByTransactionMutation>

  • Parameters

    • props: CompleteLoginProps

    Returns Promise<CompleteLogInByTransactionMutation>

    Deprecated

    Use frontendClient.auth.completeLoginViaTransaction instead

createDiscordTarget

  • createDiscordTarget(input): Promise<{
        __typename?: "DiscordTarget";
        discordAccountId?: string;
        discordServerInviteLink?: string;
        discriminator?: string;
        id: string;
        isConfirmed: boolean;
        name?: string;
        username?: string;
        userStatus: DiscordTargetStatus;
        verificationLink?: string;
    }>

  • Parameters

    • input: string

    Returns Promise<{
        __typename?: "DiscordTarget";
        discordAccountId?: string;
        discordServerInviteLink?: string;
        discriminator?: string;
        id: string;
        isConfirmed: boolean;
        name?: string;
        username?: string;
        userStatus: DiscordTargetStatus;
        verificationLink?: string;
    }>

createWebPushTarget

  • createWebPushTarget(input): Promise<CreateWebPushTargetMutation>

  • Parameters

    • input: Exact<{
          auth: string;
          endpoint: string;
          p256dh: string;
          vapidPublicKey: string;
      }>

    Returns Promise<CreateWebPushTargetMutation>

deleteAlert

  • deleteAlert(__namedParameters): Promise<void>

  • Parameters

    • __namedParameters: Readonly<{
          id: string;
      }>

    Returns Promise<void>

    Deprecated

    Use deleteAlerts instead

deleteAlerts

  • deleteAlerts(__namedParameters): Promise<{
        __typename?: "DeleteAlertsPayload";
        deleteAlertsResponse?: {
            __typename?: "DeleteAlertsResponse";
            alertsIds: string[];
        };
        errors?: ({
            __typename: "ArgumentError";
            message: string;
            paramName?: string;
        } | {
            __typename: "ArgumentNullError";
            message: string;
            paramName?: string;
        } | {
            __typename: "ArgumentOutOfRangeError";
            message: string;
            paramName?: string;
        })[];
    }>

  • Parameters

    • __namedParameters: Readonly<{
          ids: string[];
      }>

    Returns Promise<{
        __typename?: "DeleteAlertsPayload";
        deleteAlertsResponse?: {
            __typename?: "DeleteAlertsResponse";
            alertsIds: string[];
        };
        errors?: ({
            __typename: "ArgumentError";
            message: string;
            paramName?: string;
        } | {
            __typename: "ArgumentNullError";
            message: string;
            paramName?: string;
        } | {
            __typename: "ArgumentOutOfRangeError";
            message: string;
            paramName?: string;
        })[];
    }>

deleteWebPushTarget

  • deleteWebPushTarget(input): Promise<DeleteWebPushTargetMutation>

  • Parameters

    • input: Exact<{
          id: string;
      }>

    Returns Promise<DeleteWebPushTargetMutation>

ensureFusionAlerts

  • ensureFusionAlerts(input): Promise<{
        __typename?: "CreateFusionAlertsPayload";
        alerts?: {
            __typename?: "Alert";
            filterOptions: string;
            fusionEventId?: string;
            groupName?: string;
            id: string;
            name?: string;
            subscriptionValue?: string;
        }[];
        errors?: ({
            __typename: "ArgumentError";
            message: string;
            paramName?: string;
        } | {
            __typename: "ArgumentNullError";
            message: string;
            paramName?: string;
        } | {
            __typename: "ArgumentOutOfRangeError";
            message: string;
            paramName?: string;
        })[];
    }>

  • Parameters

    • input: CreateFusionAlertsInput

    Returns Promise<{
        __typename?: "CreateFusionAlertsPayload";
        alerts?: {
            __typename?: "Alert";
            filterOptions: string;
            fusionEventId?: string;
            groupName?: string;
            id: string;
            name?: string;
            subscriptionValue?: string;
        }[];
        errors?: ({
            __typename: "ArgumentError";
            message: string;
            paramName?: string;
        } | {
            __typename: "ArgumentNullError";
            message: string;
            paramName?: string;
        } | {
            __typename: "ArgumentOutOfRangeError";
            message: string;
            paramName?: string;
        })[];
    }>

ensureTargetGroup

  • ensureTargetGroup(__namedParameters): Promise<TargetGroupFragmentFragment>

  • Parameters

    • __namedParameters: Readonly<{
          discordId?: string;
          emailAddress?: string;
          name: string;
          phoneNumber?: string;
          slackId?: string;
          telegramId?: string;
          walletId?: string;
      }>

    Returns Promise<TargetGroupFragmentFragment>

    Deprecated

    Use renewTargetGroup instead

fetchFusionData

  • fetchFusionData(): Promise<FetchFusionDataQuery>

  • Returns Promise<FetchFusionDataQuery>

fetchTenantConfig

  • fetchTenantConfig(variables): Promise<TenantConfig | Readonly<{
        cardConfig: Readonly<{
            contactInfo: ContactInfoConfig;
            eventTypes: (Readonly<{
                fusionEventId: string;
                index?: (...) | (...);
                name: string;
                optOutAtSignup?: (...) | (...) | (...);
                tooltipContent?: (...) | (...);
                topicGroupName?: (...) | (...);
                type: "fusion";
            }> | Readonly<{
                name: string;
                optOutAtSignup?: (...) | (...) | (...);
                tooltipContent?: (...) | (...);
                type: "label";
            }>)[];
            id: string;
            isContactInfoRequired?: boolean;
            name: string;
            version: "v2";
        }>;
        fusionEventTopics: TopicMetadata[];
    }>>

  • Parameters

    • variables: FindSubscriptionCardParams

    Returns Promise<TenantConfig | Readonly<{
        cardConfig: Readonly<{
            contactInfo: ContactInfoConfig;
            eventTypes: (Readonly<{
                fusionEventId: string;
                index?: (...) | (...);
                name: string;
                optOutAtSignup?: (...) | (...) | (...);
                tooltipContent?: (...) | (...);
                topicGroupName?: (...) | (...);
                type: "fusion";
            }> | Readonly<{
                name: string;
                optOutAtSignup?: (...) | (...) | (...);
                tooltipContent?: (...) | (...);
                type: "label";
            }>)[];
            id: string;
            isContactInfoRequired?: boolean;
            name: string;
            version: "v2";
        }>;
        fusionEventTopics: TopicMetadata[];
    }>>

getAlerts

  • getAlerts(): Promise<readonly AlertFragmentFragment[]>

  • Returns Promise<readonly AlertFragmentFragment[]>

getFusionNotificationHistory

  • getFusionNotificationHistory(variables): Promise<Readonly<undefined | {
        __typename?: "FusionNotificationHistoryConnection";
        nodes?: {
            __typename: "FusionNotificationHistoryEntry";
            createdDate: string;
            detail?:
                | {
                    __typename: "AccountBalanceChangedEventDetails";
                    direction: AccountBalanceChangeDirection;
                    isWhaleWatch: boolean;
                    newValue: number;
                    previousValue: number;
                    tokenSymbol: string;
                    walletBlockchain: WalletBlockchain;
                }
                | {
                    __typename: "BroadcastMessageEventDetails";
                    message?: string;
                    messageHtml?: string;
                    messageType: string;
                    subject?: string;
                }
                | {
                    __typename: "ChatMessageReceivedEventDetails";
                }
                | {
                    __typename: "DAOProposalChangedEventDetails";
                    daoUrl?: string;
                    description: string;
                    proposalTitle?: string;
                    proposalUrl?: string;
                    state?: string;
                    tenantName: string;
                }
                | {
                    __typename: "DirectTenantMessageEventDetails";
                    targetTemplatesJson?: string;
                    templateVariablesJson?: string;
                    tenantName: string;
                }
                | {
                    __typename: "GenericEventDetails";
                    action?: {
                        __typename?: ...;
                        name: ...;
                        url: ...;
                    };
                    customIconUrl?: string;
                    eventDetailsJson?: string;
                    genericMessage: string;
                    genericMessageHtml?: string;
                    icon: GenericEventIconHint;
                    notificationTypeName: string;
                    sourceName: string;
                }
                | {
                    __typename: "HealthValueOverThresholdEventDetails";
                    name: string;
                    threshold: string;
                    url: string;
                    value: string;
                }
                | {
                    __typename: "NftAuctionChangedEventDetails";
                    auctionTitle: string;
                    auctionUrl?: string;
                    highBidAmount: number;
                    highBidSymbol?: string;
                    imageUrl?: string;
                    walletBlockchain: WalletBlockchain;
                }
                | {
                    __typename: "NftCollectionsReportEventDetails";
                    collections: {
                        __typename?: ...;
                        collectionId: ...;
                        imgUrl?: ...;
                        name: ...;
                        volume1Day?: ...;
                        volume1DayChange?: ...;
                    }[];
                    providerName: string;
                    sourceLink: string;
                    type: NftCollectionsReportType;
                }
                | {
                    __typename: "WalletsActivityReportEventDetails";
                    providerName: string;
                    sourceLink: string;
                    walletActivityType: "MOST_ACTIVE";
                    wallets: {
                        __typename?: ...;
                        address: ...;
                        maxPurchase1Day?: ...;
                        maxPurchaseImgUrl?: ...;
                        maxPurchaseName?: ...;
                        maxPurchaseTokenAddress?: ...;
                        volume1Day: ...;
                    }[];
                };
            fusionEventVariables: string;
            id: string;
            read: boolean;
        }[];
        pageInfo: {
            __typename?: "PageInfo";
            endCursor?: string;
            hasNextPage: boolean;
        };
    }>>

  • Parameters

    • variables: Exact<{
          after?: InputMaybe<string>;
          first?: InputMaybe<number>;
          includeHidden?: InputMaybe<boolean>;
          includeRead?: InputMaybe<boolean>;
      }>

    Returns Promise<Readonly<undefined | {
        __typename?: "FusionNotificationHistoryConnection";
        nodes?: {
            __typename: "FusionNotificationHistoryEntry";
            createdDate: string;
            detail?:
                | {
                    __typename: "AccountBalanceChangedEventDetails";
                    direction: AccountBalanceChangeDirection;
                    isWhaleWatch: boolean;
                    newValue: number;
                    previousValue: number;
                    tokenSymbol: string;
                    walletBlockchain: WalletBlockchain;
                }
                | {
                    __typename: "BroadcastMessageEventDetails";
                    message?: string;
                    messageHtml?: string;
                    messageType: string;
                    subject?: string;
                }
                | {
                    __typename: "ChatMessageReceivedEventDetails";
                }
                | {
                    __typename: "DAOProposalChangedEventDetails";
                    daoUrl?: string;
                    description: string;
                    proposalTitle?: string;
                    proposalUrl?: string;
                    state?: string;
                    tenantName: string;
                }
                | {
                    __typename: "DirectTenantMessageEventDetails";
                    targetTemplatesJson?: string;
                    templateVariablesJson?: string;
                    tenantName: string;
                }
                | {
                    __typename: "GenericEventDetails";
                    action?: {
                        __typename?: ...;
                        name: ...;
                        url: ...;
                    };
                    customIconUrl?: string;
                    eventDetailsJson?: string;
                    genericMessage: string;
                    genericMessageHtml?: string;
                    icon: GenericEventIconHint;
                    notificationTypeName: string;
                    sourceName: string;
                }
                | {
                    __typename: "HealthValueOverThresholdEventDetails";
                    name: string;
                    threshold: string;
                    url: string;
                    value: string;
                }
                | {
                    __typename: "NftAuctionChangedEventDetails";
                    auctionTitle: string;
                    auctionUrl?: string;
                    highBidAmount: number;
                    highBidSymbol?: string;
                    imageUrl?: string;
                    walletBlockchain: WalletBlockchain;
                }
                | {
                    __typename: "NftCollectionsReportEventDetails";
                    collections: {
                        __typename?: ...;
                        collectionId: ...;
                        imgUrl?: ...;
                        name: ...;
                        volume1Day?: ...;
                        volume1DayChange?: ...;
                    }[];
                    providerName: string;
                    sourceLink: string;
                    type: NftCollectionsReportType;
                }
                | {
                    __typename: "WalletsActivityReportEventDetails";
                    providerName: string;
                    sourceLink: string;
                    walletActivityType: "MOST_ACTIVE";
                    wallets: {
                        __typename?: ...;
                        address: ...;
                        maxPurchase1Day?: ...;
                        maxPurchaseImgUrl?: ...;
                        maxPurchaseName?: ...;
                        maxPurchaseTokenAddress?: ...;
                        volume1Day: ...;
                    }[];
                };
            fusionEventVariables: string;
            id: string;
            read: boolean;
        }[];
        pageInfo: {
            __typename?: "PageInfo";
            endCursor?: string;
            hasNextPage: boolean;
        };
    }>>

getTargetGroups

  • getTargetGroups(): Promise<readonly TargetGroupFragmentFragment[]>

  • Returns Promise<readonly TargetGroupFragmentFragment[]>

getUnreadNotificationHistoryCount

  • getUnreadNotificationHistoryCount(cardId?): Promise<{
        __typename?: "GetUnreadNotificationHistoryCountResponse";
        count: number;
    }>

  • Parameters

    • OptionalcardId: string

    Returns Promise<{
        __typename?: "GetUnreadNotificationHistoryCountResponse";
        count: number;
    }>

getUserSettings

  • getUserSettings(): Promise<undefined | {
        __typename?: "UserSettings";
        detailedAlertHistoryEnabled: boolean;
        ftuStage?: number;
        userHasChatEnabled: boolean;
    }>

  • Returns Promise<undefined | {
        __typename?: "UserSettings";
        detailedAlertHistoryEnabled: boolean;
        ftuStage?: number;
        userHasChatEnabled: boolean;
    }>

getWebPushTargets

  • getWebPushTargets(input): Promise<undefined | {
        __typename?: "WebPushTargetsConnection";
        edges?: {
            __typename?: "WebPushTargetsEdge";
            cursor: string;
            node: {
                __typename?: "WebPushTarget";
                createdDate: string;
                id: string;
                name?: string;
            };
        }[];
        nodes?: {
            __typename?: "WebPushTarget";
            createdDate: string;
            id: string;
            name?: string;
        }[];
        pageInfo: {
            __typename?: "PageInfo";
            endCursor?: string;
            hasNextPage: boolean;
        };
    }>

  • Parameters

    • input: Exact<{
          after?: InputMaybe<string>;
          first?: InputMaybe<number>;
          ids?: InputMaybe<string | string[]>;
      }>

    Returns Promise<undefined | {
        __typename?: "WebPushTargetsConnection";
        edges?: {
            __typename?: "WebPushTargetsEdge";
            cursor: string;
            node: {
                __typename?: "WebPushTarget";
                createdDate: string;
                id: string;
                name?: string;
            };
        }[];
        nodes?: {
            __typename?: "WebPushTarget";
            createdDate: string;
            id: string;
            name?: string;
        }[];
        pageInfo: {
            __typename?: "PageInfo";
            endCursor?: string;
            hasNextPage: boolean;
        };
    }>

initialize

  • initialize(): Promise<UserState>

  • Returns Promise<UserState>

    Deprecated

    Use frontendClient.auth.initialize instead

logIn

  • logIn(loginParams): Promise<UserFragmentFragment>

  • Parameters

    Returns Promise<UserFragmentFragment>

    Deprecated

    Use frontendClient.auth.logIn instead

logOut

  • logOut(): Promise<UserState>

  • Returns Promise<UserState>

    Deprecated

    Use frontendClient.auth.logOut instead

markFusionNotificationHistoryAsRead

  • markFusionNotificationHistoryAsRead(input): Promise<MarkFusionNotificationHistoryAsReadMutation>

  • Parameters

    • input: Exact<{
          beforeId?: InputMaybe<string>;
          ids: string | string[];
          readState?: InputMaybe<NotificationHistoryReadState>;
      }>

    Returns Promise<MarkFusionNotificationHistoryAsReadMutation>

removeEventListener

  • removeEventListener<K>(event, id): void

  • Type Parameters

    • K extends keyof NotifiSubscriptionEvents

    Parameters

    • event: K
    • id: string

    Returns void

renewTargetGroup

  • renewTargetGroup(__namedParameters): Promise<TargetGroupFragmentFragment>

  • Parameters

    • __namedParameters: Readonly<{
          discordId?: string;
          emailAddress?: string;
          name: string;
          phoneNumber?: string;
          slackId?: string;
          telegramId?: string;
          walletId?: string;
      }>

    Returns Promise<TargetGroupFragmentFragment>

    Deprecated

    use alterTargetGroup instead

    Description

    !IMPORTANT: the id arguments (telegramId, discordId, slackId, walletId) is the self-defined identity (only within notifi BE). This is NEITHER the user name NOR the user id of associated platform.

sendEmailTargetVerification

  • sendEmailTargetVerification(__namedParameters): Promise<string>

  • Parameters

    • __namedParameters: Readonly<{
          targetId: string;
      }>

    Returns Promise<string>

updateUserSettings

  • updateUserSettings(input): Promise<UpdateUserSettingsMutation>

  • Parameters

    • input: Exact<{
          input: UserSettingsInput;
      }>

    Returns Promise<UpdateUserSettingsMutation>

updateWebPushTarget

  • updateWebPushTarget(input): Promise<UpdateWebPushTargetMutation>

  • Parameters

    • input: Exact<{
          auth: string;
          endpoint: string;
          id: string;
          p256dh: string;
      }>

    Returns Promise<UpdateWebPushTargetMutation>

verifyCbwTarget

  • verifyCbwTarget(input): Promise<VerifyCbwTargetMutation>

  • Parameters

    • input: Exact<{
          input: VerifyCbwTargetInput;
      }>

    Returns Promise<VerifyCbwTargetMutation>

verifyXmtpTargetViaXip42

  • verifyXmtpTargetViaXip42(input): Promise<VerifyXmtpTargetViaXip42Mutation>

  • Parameters

    • input: Exact<{
          input: VerifyXmtpTargetViaXip42Input;
      }>

    Returns Promise<VerifyXmtpTargetViaXip42Mutation>

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods