mfa

type ChallengeOpts struct {
	// ID of the authorization factor.
	AuthenticationFactorID string

	// Parameter to customize the message for sms type factors. Must include "{{code}}" if used (opt).
	SMSTemplate string
}

type ChallengeResponse struct {
	// The authentication challenge's unique ID
	ID string `json:"id"`

	// The name of the response type.
	Object string `json:"object"`

	// The timestamp of when the request was created.
	CreatedAt string `json:"created_at"`

	// The timestamp of when the request was updated.
	UpdatedAt string `json:"updated_at"`

	// The timestamp of when the request expires.
	ExpiresAt string `json:"expires_at"`

	// The authentication factor Id used to create the request.
	AuthenticationFactorID string `json:"authentication_factor_id"`
}

type Client struct {
	// The WorkOS API Key. It can be found in https://dashboard.workos.com/api-keys.
	APIKey string

	// Defaults to http.Client.
	HTTPClient *http.Client

	// The endpoint to WorkOS API. Defaults to https://api.workos.com.
	Endpoint string

	// The function used to encode in JSON. Defaults to json.Marshal.
	JSONEncode func(v interface{}) ([]byte, error)
	// contains filtered or unexported fields
}

type EnrollResponse struct {
	// The authentication factor's unique ID
	ID string `json:"id"`

	// The name of the response type
	Object string `json:"object"`

	// The timestamp of when the request was created.
	CreatedAt string `json:"created_at"`

	// The timestamp of when the request was updated.
	UpdatedAt string `json:"updated_at"`

	// The type of request either 'sms' or 'totp'
	Type string `json:"type"`

	// Details of the totp response will be 'null' if using sms
	Totp map[string]interface{} `json:"totp"`

	// Details of the sms response will be 'null' if using totp
	Sms map[string]interface{} `json:"sms"`
}

type GetEnrollOpts struct {
	// Type of factor to be enrolled (sms or totp).
	Type string

	// Name of the Organization.
	TotpIssuer string

	// Email of user.
	TotpUser string

	// Phone Number of the User.
	PhoneNumber string
}

type RawVerifyResponse struct {
	VerifyResponse
	VerifyResponseError
}

type VerifyOpts struct {
	// The ID of the authentication challenge that provided the user the verification code.
	AuthenticationChallengeID string

	// The verification code sent to and provided by the end user.
	Code string
}

type VerifyResponse struct {
	// Return details of the request
	Challenge map[string]interface{} `json:"challenge"`

	// Boolean returning if request is valid
	Valid bool `json:"valid"`
}

type VerifyResponseError struct {
	// Returns string of error code on response with valid: false
	Code string `json:"code"`

	// Returns string of message on response with valid: false
	Message string `json:"message"`
}