streambird/dist/resources/MagicLinks.d.ts

Node.js library for the Streambird API

import { AxiosInstance } from "axios";
import { Resource } from "../Resource";
import { DeviceFingerprint } from "../shared/DeviceFingerprint";
import { MethodType } from "../shared/Enums";
import { Session } from "../shared/Session";
export declare type MagicLinkLoginOrCreateRequest = {
    email: string;
    loginRedirectUrl?: string | null;
    registrationRedirectUrl?: string | null;
    loginExpiresIn?: number | null;
    registrationExpiresIn?: number | null;
    deviceFingerprint?: DeviceFingerprint | null;
    requiresVerification?: boolean | null;
};
export declare type MagicLinkLoginOrCreateResponse = {
    userId: string;
    status: string;
    userCreated: boolean;
    updatedAt: number;
    createdAt: number;
    emailId: string;
};
export declare type MagicLinkInviteRequest = {
    email: string;
    firstName?: string;
    lastName?: string;
    middleName?: string;
    inviteRedirectUrl?: string;
    inviteExpiresIn?: number;
    deviceFingerprint?: DeviceFingerprint;
};
export declare type MagicLinkInviteResponse = {
    userId: string;
    status: string;
    userCreated: string;
    emailId: string;
};
export declare type MagicLinkEmbeddableRequest = {
    userId: string;
    expiresIn?: number;
    deviceFingerprint?: DeviceFingerprint;
};
export declare type MagicLinkEmbeddableResponse = {
    userId: string;
    token: string;
};
export declare type MagicLinkVerifyRequest = {
    token: string;
    sessionToken?: string | null;
    sessionJwt?: string | null;
    sessionExpiresIn?: number | null;
    deviceFingerprint?: DeviceFingerprint | null;
};
export declare type MagicLinkVerifyResponse = {
    userId: string;
    methodId: string;
    methodType: MethodType;
    sessionToken?: string;
    sessionJwt?: string;
    session: Session;
};
export declare class MagicLinks extends Resource<never> {
    constructor(axiosInstance: AxiosInstance);
    loginOrCreate(loginOrCreateRequest: MagicLinkLoginOrCreateRequest): Promise<MagicLinkLoginOrCreateResponse>;
    invite(inviteRequest: MagicLinkInviteRequest): Promise<MagicLinkInviteResponse>;
    create(embeddableRequest: MagicLinkEmbeddableRequest): Promise<MagicLinkEmbeddableResponse>;
    verify(verifyRequest: MagicLinkVerifyRequest): Promise<MagicLinkVerifyResponse>;
}