api

Documentation

Index

• func Dashboard(apiImplementation dashboardmodels.APIInterface, ...) error
• func GetUserForRecipeId(userId string, recipeId string) (user dashboardmodels.UserType, recipe string)
• func IsValidRecipeId(recipeId string) bool
• func MakeAPIImplementation() dashboardmodels.APIInterface
• func UsersCountGet(apiImplementation dashboardmodels.APIInterface, ...) (usersCountGetResponse, error)
• func ValidateKey(apiImplementation dashboardmodels.APIInterface, ...) error
• type User
• type Users
• type UsersGetResponse
  • func UsersGet(apiImplementation dashboardmodels.APIInterface, ...) (UsersGetResponse, error)

Functions

func Dashboard

func Dashboard(apiImplementation dashboardmodels.APIInterface, options dashboardmodels.APIOptions) error

func GetUserForRecipeId

func GetUserForRecipeId(userId string, recipeId string) (user dashboardmodels.UserType, recipe string)

This function tries to fetch a user for the given user id and recipe id. The input recipe id should be one of the primary recipes (emailpassword, thirdparty, passwordless) but the returned recipe will be the exact recipe that matched for the user (including thirdpartyemailpassword and thirdpartypasswordless).

When fetching a user we need to check for multiple recipes per input recipe id, for example a user created using email and password could be present for the EmailPassword recipe and the ThirdPartyEmailPassword recipe so we need to check for both.

If this function returns an empty user struct, it should be treated as if the user does not exist

func IsValidRecipeId

func IsValidRecipeId(recipeId string) bool

func MakeAPIImplementation

func MakeAPIImplementation() dashboardmodels.APIInterface

func UsersCountGet

func UsersCountGet(apiImplementation dashboardmodels.APIInterface, options dashboardmodels.APIOptions) (usersCountGetResponse, error)

func ValidateKey

func ValidateKey(apiImplementation dashboardmodels.APIInterface, options dashboardmodels.APIOptions) error

Types

type User

type User struct {
	Id          string                     `json:"id"`
	TimeJoined  float64                    `json:"timeJoined"`
	FirstName   string                     `json:"firstName,omitempty"`
	LastName    string                     `json:"lastName,omitempty"`
	Email       string                     `json:"email,omitempty"`
	PhoneNumber string                     `json:"phoneNumber,omitempty"`
	ThirdParty  dashboardmodels.ThirdParty `json:"thirdParty,omitempty"`
}

type Users

type Users struct {
	RecipeId string `json:"recipeId"`
	User     User   `json:"user"`
}

type UsersGetResponse

type UsersGetResponse struct {
	Status              string  `json:"status"`
	NextPaginationToken *string `json:"nextPaginationToken,omitempty"`
	Users               []Users `json:"users"`
}

func UsersGet

func UsersGet(apiImplementation dashboardmodels.APIInterface, options dashboardmodels.APIOptions) (UsersGetResponse, error)