Module recipe/thirdpartypasswordless

appleRedirectHandlerPOST: undefined | ((input: { code: string; options: ThirdPartyAPIOptions; state: string; userContext: any }) => Promise<void>)

authorisationUrlGET: undefined | ((input: { options: ThirdPartyAPIOptions; provider: TypeProvider; userContext: any }) => Promise<{ status: "OK"; url: string }>)

consumeCodePOST: undefined | ((input: ({ deviceId: string; preAuthSessionId: string; userInputCode: string } | { linkCode: string; preAuthSessionId: string }) & { options: PasswordlessAPIOptions; userContext: any }) => Promise<{ createdNewUser: boolean; session: SessionContainer; status: "OK"; user: User } | { failedCodeInputAttemptCount: number; maximumCodeInputAttempts: number; status: "INCORRECT_USER_INPUT_CODE_ERROR" | "EXPIRED_USER_INPUT_CODE_ERROR" } | { message: string; status: "GENERAL_ERROR" } | { status: "RESTART_FLOW_ERROR" }>)

createCodePOST: undefined | ((input: ({ email: string } | { phoneNumber: string }) & { options: PasswordlessAPIOptions; userContext: any }) => Promise<{ deviceId: string; flowType: "USER_INPUT_CODE" | "MAGIC_LINK" | "USER_INPUT_CODE_AND_MAGIC_LINK"; preAuthSessionId: string; status: "OK" } | { message: string; status: "GENERAL_ERROR" }>)

passwordlessUserEmailExistsGET: undefined | ((input: { email: string; options: PasswordlessAPIOptions; userContext: any }) => Promise<{ exists: boolean; status: "OK" }>)

passwordlessUserPhoneNumberExistsGET: undefined | ((input: { options: PasswordlessAPIOptions; phoneNumber: string; userContext: any }) => Promise<{ exists: boolean; status: "OK" }>)

resendCodePOST: undefined | ((input: { deviceId: string; preAuthSessionId: string } & { options: PasswordlessAPIOptions; userContext: any }) => Promise<{ message: string; status: "GENERAL_ERROR" } | { status: "RESTART_FLOW_ERROR" | "OK" }>)

thirdPartySignInUpPOST: undefined | ((input: { authCodeResponse?: any; clientId?: string; code: string; options: ThirdPartyAPIOptions; provider: TypeProvider; redirectURI: string; userContext: any }) => Promise<{ authCodeResponse: any; createdNewUser: boolean; session: SessionContainer; status: "OK"; user: User } | { error: string; status: "FIELD_ERROR" } | { status: "NO_EMAIL_GIVEN_BY_PROVIDER" }>)

consumeCode:function

• consumeCode(input: { deviceId: string; preAuthSessionId: string; userContext: any; userInputCode: string } | { linkCode: string; preAuthSessionId: string; userContext: any }): Promise<{ createdNewUser: boolean; status: "OK"; user: User } | { failedCodeInputAttemptCount: number; maximumCodeInputAttempts: number; status: "INCORRECT_USER_INPUT_CODE_ERROR" | "EXPIRED_USER_INPUT_CODE_ERROR" } | { status: "RESTART_FLOW_ERROR" }>

• Parameters

  • input: { deviceId: string; preAuthSessionId: string; userContext: any; userInputCode: string } | { linkCode: string; preAuthSessionId: string; userContext: any }

  Returns Promise<{ createdNewUser: boolean; status: "OK"; user: User } | { failedCodeInputAttemptCount: number; maximumCodeInputAttempts: number; status: "INCORRECT_USER_INPUT_CODE_ERROR" | "EXPIRED_USER_INPUT_CODE_ERROR" } | { status: "RESTART_FLOW_ERROR" }>

createCode:function

• createCode(input: ({ email: string } & { userContext: any; userInputCode?: string }) | ({ phoneNumber: string } & { userContext: any; userInputCode?: string })): Promise<{ codeId: string; codeLifetime: number; deviceId: string; linkCode: string; preAuthSessionId: string; status: "OK"; timeCreated: number; userInputCode: string }>

• Parameters

  • input: ({ email: string } & { userContext: any; userInputCode?: string }) | ({ phoneNumber: string } & { userContext: any; userInputCode?: string })

  Returns Promise<{ codeId: string; codeLifetime: number; deviceId: string; linkCode: string; preAuthSessionId: string; status: "OK"; timeCreated: number; userInputCode: string }>

createNewCodeForDevice:function

• createNewCodeForDevice(input: { deviceId: string; userContext: any; userInputCode?: string }): Promise<{ codeId: string; codeLifetime: number; deviceId: string; linkCode: string; preAuthSessionId: string; status: "OK"; timeCreated: number; userInputCode: string } | { status: "RESTART_FLOW_ERROR" | "USER_INPUT_CODE_ALREADY_USED_ERROR" }>

• Parameters

  • input: { deviceId: string; userContext: any; userInputCode?: string }

    • deviceId: string

    • userContext: any

    • Optional userInputCode?: string

  Returns Promise<{ codeId: string; codeLifetime: number; deviceId: string; linkCode: string; preAuthSessionId: string; status: "OK"; timeCreated: number; userInputCode: string } | { status: "RESTART_FLOW_ERROR" | "USER_INPUT_CODE_ALREADY_USED_ERROR" }>

getUserById:function

• getUserById(input: { userContext: any; userId: string }): Promise<undefined | ({ email?: string; phoneNumber?: string } & { id: string; timeJoined: number }) | ({ email: string; thirdParty: { id: string; userId: string } } & { id: string; timeJoined: number })>

• Parameters

  • input: { userContext: any; userId: string }

    • userContext: any

    • userId: string

  Returns Promise<undefined | ({ email?: string; phoneNumber?: string } & { id: string; timeJoined: number }) | ({ email: string; thirdParty: { id: string; userId: string } } & { id: string; timeJoined: number })>

getUserByPhoneNumber:function

• getUserByPhoneNumber(input: { phoneNumber: string; userContext: any }): Promise<undefined | ({ email?: string; phoneNumber?: string } & { id: string; timeJoined: number }) | ({ email: string; thirdParty: { id: string; userId: string } } & { id: string; timeJoined: number })>

• Parameters

  • input: { phoneNumber: string; userContext: any }

    • phoneNumber: string

    • userContext: any

  Returns Promise<undefined | ({ email?: string; phoneNumber?: string } & { id: string; timeJoined: number }) | ({ email: string; thirdParty: { id: string; userId: string } } & { id: string; timeJoined: number })>

getUserByThirdPartyInfo:function

• getUserByThirdPartyInfo(input: { thirdPartyId: string; thirdPartyUserId: string; userContext: any }): Promise<undefined | ({ email?: string; phoneNumber?: string } & { id: string; timeJoined: number }) | ({ email: string; thirdParty: { id: string; userId: string } } & { id: string; timeJoined: number })>

• Parameters

  • input: { thirdPartyId: string; thirdPartyUserId: string; userContext: any }

    • thirdPartyId: string

    • thirdPartyUserId: string

    • userContext: any

  Returns Promise<undefined | ({ email?: string; phoneNumber?: string } & { id: string; timeJoined: number }) | ({ email: string; thirdParty: { id: string; userId: string } } & { id: string; timeJoined: number })>

getUsersByEmail:function

• getUsersByEmail(input: { email: string; userContext: any }): Promise<User[]>

• Parameters

  • input: { email: string; userContext: any }

    • email: string

    • userContext: any

  Returns Promise<User[]>

listCodesByDeviceId:function

• listCodesByDeviceId(input: { deviceId: string; userContext: any }): Promise<undefined | DeviceType>

• Parameters

  • input: { deviceId: string; userContext: any }

    • deviceId: string

    • userContext: any

  Returns Promise<undefined | DeviceType>

listCodesByEmail:function

• listCodesByEmail(input: { email: string; userContext: any }): Promise<DeviceType[]>

• Parameters

  • input: { email: string; userContext: any }

    • email: string

    • userContext: any

  Returns Promise<DeviceType[]>

listCodesByPhoneNumber:function

• listCodesByPhoneNumber(input: { phoneNumber: string; userContext: any }): Promise<DeviceType[]>

• Parameters

  • input: { phoneNumber: string; userContext: any }

    • phoneNumber: string

    • userContext: any

  Returns Promise<DeviceType[]>

listCodesByPreAuthSessionId:function

• listCodesByPreAuthSessionId(input: { preAuthSessionId: string; userContext: any }): Promise<undefined | DeviceType>

• Parameters

  • input: { preAuthSessionId: string; userContext: any }

    • preAuthSessionId: string

    • userContext: any

  Returns Promise<undefined | DeviceType>

revokeAllCodes:function

• revokeAllCodes(input: { email: string; userContext: any } | { phoneNumber: string; userContext: any }): Promise<{ status: "OK" }>

• Parameters

  • input: { email: string; userContext: any } | { phoneNumber: string; userContext: any }

  Returns Promise<{ status: "OK" }>

revokeCode:function

• revokeCode(input: { codeId: string; userContext: any }): Promise<{ status: "OK" }>

• Parameters

  • input: { codeId: string; userContext: any }

    • codeId: string

    • userContext: any

  Returns Promise<{ status: "OK" }>

thirdPartySignInUp:function

• thirdPartySignInUp(input: { email: { id: string; isVerified: boolean }; thirdPartyId: string; thirdPartyUserId: string; userContext: any }): Promise<{ createdNewUser: boolean; status: "OK"; user: User } | { error: string; status: "FIELD_ERROR" }>

• Parameters

  • input: { email: { id: string; isVerified: boolean }; thirdPartyId: string; thirdPartyUserId: string; userContext: any }

    • email: { id: string; isVerified: boolean }

      • id: string

      • isVerified: boolean

    • thirdPartyId: string

    • thirdPartyUserId: string

    • userContext: any

  Returns Promise<{ createdNewUser: boolean; status: "OK"; user: User } | { error: string; status: "FIELD_ERROR" }>

updatePasswordlessUser:function

• updatePasswordlessUser(input: { email?: string | null; phoneNumber?: string | null; userContext: any; userId: string }): Promise<{ status: "OK" | "UNKNOWN_USER_ID_ERROR" | "EMAIL_ALREADY_EXISTS_ERROR" | "PHONE_NUMBER_ALREADY_EXISTS_ERROR" }>

• Parameters

  • input: { email?: string | null; phoneNumber?: string | null; userContext: any; userId: string }

    • Optional email?: string | null

    • Optional phoneNumber?: string | null

    • userContext: any

    • userId: string

  Returns Promise<{ status: "OK" | "UNKNOWN_USER_ID_ERROR" | "EMAIL_ALREADY_EXISTS_ERROR" | "PHONE_NUMBER_ALREADY_EXISTS_ERROR" }>