mfa

type Challenge 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.
	FactorID string `json:"authentication_factor_id"`
}

type ChallengeFactorOpts struct {
	// ID of the authorization factor.
	FactorID string

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

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 DeleteFactorOpts struct {
	// ID of factor to be deleted
	FactorID string
}

type EnrollFactorOpts struct {

	// Type of factor to be enrolled (sms or totp).
	Type FactorType

	// Name of the Organization.
	TOTPIssuer string

	// Email of user.
	TOTPUser string

	// Phone Number of the User.
	PhoneNumber string
}

type Factor 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 FactorType `json:"type"`

	// Details of the totp response will be 'null' if using sms
	TOTP TOTPDetails `json:"totp"`

	// Details of the sms response will be 'null' if using totp
	SMS SMSDetails `json:"sms"`
}

type FactorType string

type GetFactorOpts struct {
	// ID of the factor.
	FactorID string
}

type RawVerifyChallengeResponse struct {
	VerifyChallengeResponse
	VerifyChallengeResponseError
}

type SMSDetails struct {
	PhoneNumber string `json:"phone_number"`
}

type TOTPDetails struct {
	QRCode string `json:"qr_code"`
	Secret string `json:"secret"`
	URI    string `json:"uri"`
}

type VerificationResponseError struct {
	Code    string
	Message string
}

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

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

type VerifyChallengeResponse struct {
	// Return details of the request
	Challenge Challenge `json:"challenge"`

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

type VerifyChallengeResponseError 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"`
}