passwordauth

type Auther interface {
	// APIKeyAuth implements the authorization logic for the APIKey security scheme.
	APIKeyAuth(ctx context.Context, key string, schema *security.APIKeyScheme) (context.Context, error)
	// JWTAuth implements the authorization logic for the JWT security scheme.
	JWTAuth(ctx context.Context, token string, schema *security.JWTScheme) (context.Context, error)
}

type ChangePasswordParams struct {
	// The old password for the current user account
	OldPassword *string
	// The new password for the current user account
	NewPassword   string
	Authorization string
	XSession      string
	APIKey        *string
}

type CheckEmailAvailablePayload struct {
	Email  *string
	APIKey *string
}

type CheckPhoneAvailablePayload struct {
	Phone  *string
	APIKey *string
}

type Client struct {
	RegisterEndpoint            goa.Endpoint
	LoginEndpoint               goa.Endpoint
	RemoveEndpoint              goa.Endpoint
	ChangePasswordEndpoint      goa.Endpoint
	ResetEndpoint               goa.Endpoint
	ConfirmResetEndpoint        goa.Endpoint
	CheckEmailAvailableEndpoint goa.Endpoint
	CheckPhoneAvailableEndpoint goa.Endpoint
}

type Endpoints struct {
	Register            goa.Endpoint
	Login               goa.Endpoint
	Remove              goa.Endpoint
	ChangePassword      goa.Endpoint
	Reset               goa.Endpoint
	ConfirmReset        goa.Endpoint
	CheckEmailAvailable goa.Endpoint
	CheckPhoneAvailable goa.Endpoint
}

type LoginParams struct {
	// The email address of the account to login to
	Email string
	// The password of the account to login to
	Password string
	// 2 Factor Auth if user has enabled the feature
	TwoFactor *string
	Token     *string
	APIKey    *string
}

type RegisterParams struct {
	// The email that will be attached to the account
	Email string
	// The user's given name
	FirstName string
	// The user's family name
	LastName string
	// The password associated with the new account
	Password string
	// The user's phone number
	Phone *string
	// The recaptcha response code
	GRecaptchaResponse string
	Authorization      *string
	XSession           *string
	APIKey             *string
}

type RemovePayload struct {
	Authorization *string
	XSession      *string
	APIKey        *string
}

type ResetPasswordParams struct {
	// The UUID of the password reset, send from the user's email
	ResetCode string
	// The ID of the user to reset the password of
	UserID string
	// The new password that will be used to login to the account
	NewPassword string
	APIKey      *string
}

type ResetPayload struct {
	Email  *string
	APIKey *string
}

type Service interface {
	// Register a new user with an email and password
	Register(context.Context, *RegisterParams) (res *UserMedia, err error)
	// Login a user using an email and password
	Login(context.Context, *LoginParams) (res *UserMedia, err error)
	// Removes using a password as a login method
	Remove(context.Context, *RemovePayload) (err error)
	// Changes the user's current password to a new one, also adds a password to
	// the account if there is none
	ChangePassword(context.Context, *ChangePasswordParams) (err error)
	// Send an email to user to get a password reset, responds with no content even
	// if the email is not on any user account
	Reset(context.Context, *ResetPayload) (err error)
	// Confirms that a reset has been completed and changes the password to the new
	// one passed in
	ConfirmReset(context.Context, *ResetPasswordParams) (err error)
	// Checks if an email is available for signup
	CheckEmailAvailable(context.Context, *CheckEmailAvailablePayload) (res bool, err error)
	// Checks if an phone is available for signup
	CheckPhoneAvailable(context.Context, *CheckPhoneAvailablePayload) (res bool, err error)
}

type UserMedia struct {
	// Unique unchanging user ID
	ID string
	// Given name for the user
	FirstName string
	// Family name for the user
	LastName string
	// Email attached to the account of the user
	Email string
	// Phone Number Of the user
	Phone string
	// When the user attempts to change their email, this is what they will change
	// it to after they verify that it belongs to them
	ChangingEmail *string
	// Whether the user has verified their email
	VerifiedEmail bool
	// Whether the user is an administrator on the site
	IsAdmin          *bool
	UpdatedAt        *string
	IsActive         *bool
	CreatedAt        *string
	CountryPhoneCode *string
	Authorization    string
	XSession         string
}