usermanagement

type AuthenticateResponse struct {
	User User `json:"user"`

	// Which Organization the user is signing in to.
	// If the user is a member of multiple organizations, this is the organization the user selected
	// as part of the authentication flow.
	// If the user is a member of only one organization, this is that organization.
	// If the user is not a member of any organizations, this is null.
	OrganizationID string `json:"organization_id"`

	// The AccessToken can be validated to confirm that a user has an active session.
	AccessToken string `json:"access_token"`

	// This RefreshToken can be used to obtain a new AccessToken using
	// `AuthenticateWithRefreshToken`
	RefreshToken string `json:"refresh_token"`

	// The authentication method used to authenticate the user.
	AuthenticationMethod AuthenticationMethod `json:"authentication_method"`

	// Present if the authenticated user is being impersonated.
	Impersonator *Impersonator `json:"impersonator"`

	// Third party OAuth provider tokens. Present if configured in the WorkOS Dashboard.
	OAuthTokens *OAuthTokens `json:"oauth_tokens,omitempty"`
}

type AuthenticateWithCodeOpts struct {
	ClientID     string `json:"client_id"`
	Code         string `json:"code"`
	CodeVerifier string `json:"code_verifier,omitempty"`
	IPAddress    string `json:"ip_address,omitempty"`
	UserAgent    string `json:"user_agent,omitempty"`
}

type AuthenticateWithEmailVerificationCodeOpts struct {
	ClientID                   string `json:"client_id"`
	Code                       string `json:"code"`
	PendingAuthenticationToken string `json:"pending_authentication_token"`
	IPAddress                  string `json:"ip_address,omitempty"`
	UserAgent                  string `json:"user_agent,omitempty"`
}

type AuthenticateWithMagicAuthOpts struct {
	ClientID string `json:"client_id"`
	Code     string `json:"code"`
	Email    string `json:"email"`

	// An authorization code used in a previous authenticate request that resulted in an existing user error response.
	// By specifying link_authorization_code, the Magic Auth authentication will link the credentials of the previous
	// authorization code with this user.
	LinkAuthorizationCode string `json:"link_authorization_code,omitempty"`
	IPAddress             string `json:"ip_address,omitempty"`
	UserAgent             string `json:"user_agent,omitempty"`
}

type AuthenticateWithOrganizationSelectionOpts struct {
	ClientID                   string `json:"client_id"`
	PendingAuthenticationToken string `json:"pending_authentication_token"`
	OrganizationID             string `json:"organization_id"`
	IPAddress                  string `json:"ip_address,omitempty"`
	UserAgent                  string `json:"user_agent,omitempty"`
}

type AuthenticateWithPasswordOpts struct {
	ClientID  string `json:"client_id"`
	Email     string `json:"email"`
	Password  string `json:"password"`
	IPAddress string `json:"ip_address,omitempty"`
	UserAgent string `json:"user_agent,omitempty"`
}

type AuthenticateWithRefreshTokenOpts struct {
	ClientID       string `json:"client_id"`
	RefreshToken   string `json:"refresh_token"`
	OrganizationID string `json:"organization_id,omitempty"`
	IPAddress      string `json:"ip_address,omitempty"`
	UserAgent      string `json:"user_agent,omitempty"`
}

type AuthenticateWithTOTPOpts struct {
	ClientID                   string `json:"client_id"`
	Code                       string `json:"code"`
	IPAddress                  string `json:"ip_address,omitempty"`
	UserAgent                  string `json:"user_agent,omitempty"`
	PendingAuthenticationToken string `json:"pending_authentication_token"`
	AuthenticationChallengeID  string `json:"authentication_challenge_id"`
}

type AuthenticationMethod string

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

	// The http.Client that is used to send request to WorkOS.
	//
	// 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)
}

type CreateMagicAuthOpts struct {
	// The email address the one-time code is for.
	Email           string `json:"email"`
	InvitationToken string `json:"invitation_token,omitempty"`
}

type CreateOrganizationMembershipOpts struct {
	// The ID of the User to add as a member.
	UserID string `json:"user_id"`

	// The ID of the Organization in which to add the User as a member.
	OrganizationID string `json:"organization_id"`

	// The slug of the Role in which to grant this membership. If no RoleSlug is given, the default role will be granted. Mutually exclusive with RoleSlugs.
	// OPTIONAL
	RoleSlug string `json:"role_slug,omitempty"`

	// The slugs of the Roles in which to grant this membership. Mutually exclusive with `role_slug`. Limited to one role when Multiple Roles is disabled.
	// OPTIONAL
	RoleSlugs []string `json:"role_slugs,omitempty"`
}

type CreatePasswordResetOpts struct {
	// The email address the password reset is for.
	Email string `json:"email"`
}

type CreateUserOpts struct {
	Email            string            `json:"email"`
	Password         string            `json:"password,omitempty"`
	PasswordHash     string            `json:"password_hash,omitempty"`
	PasswordHashType PasswordHashType  `json:"password_hash_type,omitempty"`
	FirstName        string            `json:"first_name,omitempty"`
	LastName         string            `json:"last_name,omitempty"`
	EmailVerified    bool              `json:"email_verified,omitempty"`
	ExternalID       string            `json:"external_id,omitempty"`
	Metadata         map[string]string `json:"metadata,omitempty"`
}

type DeactivateOrganizationMembershipOpts struct {
	// Organization Membership unique identifier
	OrganizationMembership string
}

type DeleteOrganizationMembershipOpts struct {
	// The ID of the Organization Membership to delete.
	OrganizationMembership string
}

type DeleteUserOpts struct {
	User string
}

type EmailVerification struct {
	ID        string `json:"id"`
	UserId    string `json:"user_id"`
	Email     string `json:"email"`
	ExpiresAt string `json:"expires_at"`
	Code      string `json:"code"`
	CreatedAt string `json:"created_at"`
	UpdatedAt string `json:"updated_at"`
}

type EnrollAuthFactorOpts struct {
	User       string
	Type       mfa.FactorType `json:"type"`
	TOTPIssuer string         `json:"totp_issuer,omitempty"`
	TOTPUser   string         `json:"totp_user,omitempty"`
	TOTPSecret string         `json:"totp_secret,omitempty"`
}

type EnrollAuthFactorResponse struct {
	Factor    mfa.Factor    `json:"authentication_factor"`
	Challenge mfa.Challenge `json:"authentication_challenge"`
}

type FindInvitationByTokenOpts struct {
	InvitationToken string
}

type GetAuthorizationURLOpts struct {
	// Your WorkOS Project's Client ID.
	//
	// REQUIRED.
	ClientID string
	//Optional Used for PKCE
	CodeChallenge string
	//Optional Used for PKCE
	CodeChallengeMethod string
	// The callback URL where your app redirects the user after an
	// authorization code is granted (eg. https://foo.com/callback).
	//
	// REQUIRED.
	RedirectURI string

	// The Provider connection selector is used to initiate SSO using an OAuth-compatible provider.
	Provider string

	// The ConnectionID connection selector is used to initiate SSO for a Connection.
	ConnectionID string

	// The organization_id connection selector is used to initiate SSO for an Organization.
	OrganizationID string

	// Use state to encode arbitrary information to restore state through redirects.
	//
	// OPTIONAL.
	State string

	// Username/email hint that will be passed as a parameter to the to IdP login page.
	// OPTIONAL.
	LoginHint string

	// Domain hint that will be passed as a parameter to the IdP login page.
	// OPTIONAL.
	DomainHint string

	// ScreenHint represents the screen to redirect the user to when the provider is Authkit.
	// OPTIONAL.
	ScreenHint ScreenHint

	// Additional OAuth scopes to request during authentication
	// OPTIONAL.
	ProviderScopes []string `json:"provider_scopes,omitempty"`
}

type GetEmailVerificationOpts struct {
	// The Email Verification's unique identifier.
	EmailVerification string
}

type GetInvitationOpts struct {
	Invitation string
}

type GetLogoutURLOpts struct {
	// The ID of the session that will end. This is in the `sid` claim of the
	// AccessToken
	//
	// REQUIRED
	SessionID string

	// The URL to redirect the user to after they have logged out.
	ReturnTo string
}

type GetMagicAuthOpts struct {
	MagicAuth string
}

type GetOrganizationMembershipOpts struct {
	// Organization Membership unique identifier
	OrganizationMembership string
}

type GetPasswordResetOpts struct {
	// The Password Reset's unique identifier.
	PasswordReset string
}

type GetUserByExternalIDOpts struct {
	ExternalID string
}

type GetUserOpts struct {
	// User unique identifier
	User string `json:"id"`
}

type Identity struct {
	// The unique ID of the user in the external identity provider.
	IdpID string `json:"idp_id"`
	// The type of the identity.
	Type string `json:"type"`
	// The type of OAuth provider for the identity.
	Provider string `json:"provider"`
}

type Impersonator struct {
	// The email address of the WorkOS Dashboard user using impersonation.
	Email string `json:"email"`

	// The reason provided by the impersonator for impersonating the user.
	Reason string `json:"reason"`
}

type Invitation struct {
	ID                  string          `json:"id"`
	Email               string          `json:"email"`
	State               InvitationState `json:"state"`
	AcceptedAt          string          `json:"accepted_at,omitempty"`
	RevokedAt           string          `json:"revoked_at,omitempty"`
	Token               string          `json:"token"`
	AcceptInvitationUrl string          `json:"accept_invitation_url"`
	OrganizationID      string          `json:"organization_id,omitempty"`
	InviterUserID       string          `json:"inviter_user_id,omitempty"`
	ExpiresAt           string          `json:"expires_at"`
	CreatedAt           string          `json:"created_at"`
	UpdatedAt           string          `json:"updated_at"`
}

type InvitationState string

type ListAuthFactorsOpts struct {
	User string
}

type ListAuthFactorsResponse struct {
	Data []mfa.Factor `json:"data"`

	ListMetadata common.ListMetadata `json:"list_metadata"`
}

type ListIdentitiesOpts struct {
	ID string `json:"id"`
}

type ListIdentitiesResult = []Identity

type ListInvitationsOpts struct {
	OrganizationID string `url:"organization_id,omitempty"`

	Email string `url:"email,omitempty"`

	// Maximum number of records to return.
	Limit int `url:"limit"`

	// The order in which to paginate records.
	Order Order `url:"order,omitempty"`

	// Pagination cursor to receive records before a provided User ID.
	Before string `url:"before,omitempty"`

	// Pagination cursor to receive records after a provided User ID.
	After string `url:"after,omitempty"`
}

type ListInvitationsResponse struct {
	// List of Invitations
	Data []Invitation `json:"data"`

	// Cursor to paginate through the list of Invitations
	ListMetadata common.ListMetadata `json:"list_metadata"`
}

type ListOrganizationMembershipsOpts struct {
	// Filter memberships by Organization ID.
	OrganizationID string `url:"organization_id,omitempty"`

	// Filter memberships by User ID.
	UserID string `url:"user_id,omitempty"`

	// Filter memberships by status
	Statuses []OrganizationMembershipStatus `url:"statuses,omitempty"`

	// Maximum number of records to return.
	Limit int `url:"limit"`

	// The order in which to paginate records.
	Order Order `url:"order,omitempty"`

	// Pagination cursor to receive records before a provided
	// Organization Membership ID.
	Before string `url:"before,omitempty"`

	// Pagination cursor to receive records after a provided
	// Organization Membership ID.
	After string `url:"after,omitempty"`
}

type ListOrganizationMembershipsResponse struct {
	Data []OrganizationMembership `json:"data"`

	ListMetadata common.ListMetadata `json:"list_metadata"`
}

type ListUsersOpts struct {
	// Filter Users by their email.
	Email string `url:"email,omitempty"`

	// Filter Users by the organization they are members of.
	OrganizationID string `url:"organization_id,omitempty"`

	// Maximum number of records to return.
	Limit int `url:"limit"`

	// The order in which to paginate records.
	Order Order `url:"order,omitempty"`

	// Pagination cursor to receive records before a provided User ID.
	Before string `url:"before,omitempty"`

	// Pagination cursor to receive records after a provided User ID.
	After string `url:"after,omitempty"`
}

type ListUsersResponse struct {
	// List of Users
	Data []User `json:"data"`

	// Cursor to paginate through the list of Users
	ListMetadata common.ListMetadata `json:"list_metadata"`
}

type MagicAuth struct {
	ID        string `json:"id"`
	UserId    string `json:"user_id"`
	Email     string `json:"email"`
	ExpiresAt string `json:"expires_at"`
	Code      string `json:"code"`
	CreatedAt string `json:"created_at"`
	UpdatedAt string `json:"updated_at"`
}

type OAuthTokens struct {
	// The access token from the OAuth provider
	AccessToken string `json:"access_token"`

	// The refresh token from the OAuth provider
	RefreshToken string `json:"refresh_token"`

	// The scopes granted by the OAuth provider
	Scopes []string `json:"scopes"`

	// The expiration time of the access token
	ExpiresAt int `json:"expires_at"`
}

type Order string

type Organization struct {
	// The Organization's unique identifier.
	ID string `json:"id"`

	// The Organization's name.
	Name string `json:"name"`
}

type OrganizationMembership struct {
	// The Organization Membership's unique identifier.
	ID string `json:"id"`

	// The ID of the User.
	UserID string `json:"user_id"`

	// The ID of the Organization.
	OrganizationID string `json:"organization_id"`

	// The name of the Organization.
	OrganizationName string `json:"organization_name"`

	// The role given to this Organization Membership or priority role if multiple roles are assigned.
	Role common.RoleResponse `json:"role"`

	// All roles for the Organization Membership
	Roles []common.RoleResponse `json:"roles"`

	// The Status of the Organization.
	Status OrganizationMembershipStatus `json:"status"`

	// CreatedAt is the timestamp of when the OrganizationMembership was created.
	CreatedAt string `json:"created_at"`

	// UpdatedAt is the timestamp of when the OrganizationMembership was updated.
	UpdatedAt string `json:"updated_at"`
}

type OrganizationMembershipStatus string

type PasswordHashType string

type PasswordReset struct {
	ID                 string `json:"id"`
	UserId             string `json:"user_id"`
	Email              string `json:"email"`
	PasswordResetToken string `json:"password_reset_token"`
	PasswordResetUrl   string `json:"password_reset_url"`
	ExpiresAt          string `json:"expires_at"`
	CreatedAt          string `json:"created_at"`
}

type ReactivateOrganizationMembershipOpts struct {
	// Organization Membership unique identifier
	OrganizationMembership string
}

type RefreshAuthenticationResponse struct {
	// The AccessToken can be validated to confirm that a user has an active session.
	AccessToken string `json:"access_token"`

	// This RefreshToken can be used to obtain a new AccessToken using
	// `AuthenticateWithRefreshToken`
	RefreshToken string `json:"refresh_token"`
}

type ResendInvitationOpts struct {
	Invitation string
}

type ResetPasswordOpts struct {
	// The verification token emailed to the user.
	Token string `json:"token"`

	// The new password to be set for the user.
	NewPassword string `json:"new_password"`
}

type RevokeInvitationOpts struct {
	Invitation string
}

type RevokeSessionOpts struct {
	SessionID string `json:"session_id"`
}

type ScreenHint string

type SendInvitationOpts struct {
	Email          string `json:"email"`
	OrganizationID string `json:"organization_id,omitempty"`
	ExpiresInDays  int    `json:"expires_in_days,omitempty"`
	InviterUserID  string `json:"inviter_user_id,omitempty"`
	RoleSlug       string `json:"role_slug,omitempty"`
}

type SendMagicAuthCodeOpts struct {
	// The email address the one-time code will be sent to.
	Email string `json:"email"`
}

type SendPasswordResetEmailOpts struct {
	// The unique ID of the User whose email address will be verified.
	Email string `json:"email"`

	// The URL that will be linked to in the verification email.
	PasswordResetUrl string `json:"password_reset_url"`
}

type SendVerificationEmailOpts struct {
	// The unique ID of the User who will be sent a verification email.
	User string
}

type UpdateOrganizationMembershipOpts struct {
	// The slug of the Role to update to for this membership.
	// OPTIONAL
	RoleSlug string `json:"role_slug,omitempty"`

	// The slugs of the Roles to update this membership to. Mutually exclusive with `role_slug`. Limited to one role when Multiple Roles is disabled.
	// OPTIONAL
	RoleSlugs []string `json:"role_slugs,omitempty"`
}

type UpdateUserOpts struct {
	User             string
	Email            string             `json:"email,omitempty"`
	FirstName        string             `json:"first_name,omitempty"`
	LastName         string             `json:"last_name,omitempty"`
	EmailVerified    bool               `json:"email_verified,omitempty"`
	Password         string             `json:"password,omitempty"`
	PasswordHash     string             `json:"password_hash,omitempty"`
	PasswordHashType PasswordHashType   `json:"password_hash_type,omitempty"`
	ExternalID       string             `json:"external_id,omitempty"`
	Metadata         map[string]*string `json:"metadata,omitempty"`
}

type User = common.User

type UserResponse struct {
	User User `json:"user"`
}

type VerifyEmailOpts struct {
	// The unique ID of the User whose email address will be verified.
	User string
	// The verification code emailed to the user.
	Code string `json:"code"`
}