stytch_codecs - v1.0.0-rc1

stytch_codecs

Types

AuthenticateResponse

</>

Response from Stytch when attempting to autenticate with any method.

pub type AuthenticateResponse {
  AuthenticateResponse(
    status_code: Int,
    request_id: String,
    user_id: String,
    method_id: String,
    session_token: String,
    session_jwt: String,
  )
}

Constructors 

  • AuthenticateResponse(
  status_code: Int,
  request_id: String,
  user_id: String,
  method_id: String,
  session_token: String,
  session_jwt: String,
)

Email

</>

Email identifying a user. Stytch separates email_id (not PII) from email and indicates whether the user has verified that they can access that address.

pub type Email {
  Email(email_id: String, email: String, verified: Bool)
}

Constructors 

  • Email(email_id: String, email: String, verified: Bool)

LoginOrCreateResponse

</>

Response to a request to create or log into an account.

Used by both magic links and OTP login_or_create

pub type LoginOrCreateResponse {
  LoginOrCreateResponse(
    status_code: Int,
    request_id: String,
    user_id: String,
    email_id: String,
  )
}

Constructors 

  • LoginOrCreateResponse(
  status_code: Int,
  request_id: String,
  user_id: String,
  email_id: String,
)

MagicLinkLoginOrCreateRequest

</>

Request to create a magic link. When stytch receives this request, it will send an e-mail, authenticate the user in the clicked link, and redirect back to somewhere in your service.

pub type MagicLinkLoginOrCreateRequest {
  MagicLinkLoginOrCreateRequest(email: String)
}

Constructors 

  • MagicLinkLoginOrCreateRequest(email: String)

Name

</>

Name identifying a user.

pub type Name {
  Name(
    first_name: String,
    middle_name: String,
    last_name: String,
  )
}

Constructors 

  • Name(first_name: String, middle_name: String, last_name: String)

PasscodeAuthenticateRequest

</> 
pub type PasscodeAuthenticateRequest {
  PasscodeAuthenticateRequest(
    code: String,
    method_id: String,
    session_duration_minutes: Int,
  )
}

Constructors 

  • PasscodeAuthenticateRequest(
  code: String,
  method_id: String,
  session_duration_minutes: Int,
)

PasscodeLoginOrCreateRequest

</>

Request to log in with a passcode. When stytch receives this it will send a passcode to the user’s e-mail address. It is up to you to process the passcode and authenticate it with stytch.

pub type PasscodeLoginOrCreateRequest {
  PasscodeLoginOrCreateRequest(email: String)
}

Constructors 

  • PasscodeLoginOrCreateRequest(email: String)

SessionAuthenticateResponse

</> 
pub type SessionAuthenticateResponse {
  SessionAuthenticateResponse(
    status_code: Int,
    request_id: String,
    user: StytchUser,
    session_token: String,
    session_jwt: String,
  )
}

Constructors 

  • SessionAuthenticateResponse(
  status_code: Int,
  request_id: String,
  user: StytchUser,
  session_token: String,
  session_jwt: String,
)

SessionRevokeRequest

</>

Request to revoke a session.

Use for signout.

pub type SessionRevokeRequest {
  SessionRevokeRequest(session_token: String)
}

Constructors 

  • SessionRevokeRequest(session_token: String)

SessionRevokeResponse

</>

Response from stytch to a request to revoke a given session token.

pub type SessionRevokeResponse {
  SessionRevokeResponse(request_id: String, status_code: Int)
}

Constructors 

  • SessionRevokeResponse(request_id: String, status_code: Int)

SessionTokenAuthenticateRequest

</> 
pub type SessionTokenAuthenticateRequest {
  SessionTokenAuthenticateRequest(
    session_token: String,
    session_duration_minutes: Int,
  )
}

Constructors 

  • SessionTokenAuthenticateRequest(
  session_token: String,
  session_duration_minutes: Int,
)

StytchClientError

</>

Error messages received from the stytch service

pub type StytchClientError {
  StytchClientError(
    status_code: Int,
    request_id: String,
    error_type: String,
    error_message: String,
    error_url: String,
  )
}

Constructors 

  • StytchClientError(
  status_code: Int,
  request_id: String,
  error_type: String,
  error_message: String,
  error_url: String,
)

StytchUser

</> 
pub type StytchUser {
  StytchUser(user_id: String, name: Name, emails: List(Email))
}

Constructors 

  • StytchUser(user_id: String, name: Name, emails: List(Email))

TokenAuthenticateRequest

</>

Request to authenticate a stytch token returned from login.

pub type TokenAuthenticateRequest {
  TokenAuthenticateRequest(
    token: String,
    session_duration_minutes: Int,
  )
}

Constructors 

  • TokenAuthenticateRequest(
  token: String,
  session_duration_minutes: Int,
)

Values

authenticate_response_decoder

</> 
pub fn authenticate_response_decoder() -> decode.Decoder(
  AuthenticateResponse,
)

authenticate_response_to_json

</> 
pub fn authenticate_response_to_json(
  magic_link_authenticate_response: AuthenticateResponse,
) -> json.Json

email_decoder

</> 
pub fn email_decoder() -> decode.Decoder(Email)

email_to_json

</> 
pub fn email_to_json(email: Email) -> json.Json

login_or_create_response_decoder

</> 
pub fn login_or_create_response_decoder() -> decode.Decoder(
  LoginOrCreateResponse,
)

login_or_create_response_to_json

</> 
pub fn login_or_create_response_to_json(
  magic_link_login_or_create_response: LoginOrCreateResponse,
) -> json.Json
</> 
pub fn magic_link_login_or_create_request_decoder() -> decode.Decoder(
  MagicLinkLoginOrCreateRequest,
)
</> 
pub fn magic_link_login_or_create_request_to_json(
  magic_link_login_or_create_request: MagicLinkLoginOrCreateRequest,
) -> json.Json

name_decoder

</> 
pub fn name_decoder() -> decode.Decoder(Name)

name_to_json

</> 
pub fn name_to_json(name: Name) -> json.Json

passcode_authenticate_request_decoder

</> 
pub fn passcode_authenticate_request_decoder() -> decode.Decoder(
  PasscodeAuthenticateRequest,
)

passcode_authenticate_request_to_json

</> 
pub fn passcode_authenticate_request_to_json(
  passcode_authenticate_request: PasscodeAuthenticateRequest,
) -> json.Json

passcode_login_or_create_request_decoder

</> 
pub fn passcode_login_or_create_request_decoder() -> decode.Decoder(
  PasscodeLoginOrCreateRequest,
)

passcode_login_or_create_request_to_json

</> 
pub fn passcode_login_or_create_request_to_json(
  passcode_login_or_create_request: PasscodeLoginOrCreateRequest,
) -> json.Json

session_authenticate_response_decoder

</> 
pub fn session_authenticate_response_decoder() -> decode.Decoder(
  SessionAuthenticateResponse,
)

session_authenticate_response_to_json

</> 
pub fn session_authenticate_response_to_json(
  session_authenticate_response: SessionAuthenticateResponse,
) -> json.Json

session_revoke_request_decoder

</> 
pub fn session_revoke_request_decoder() -> decode.Decoder(
  SessionRevokeRequest,
)

session_revoke_request_to_json

</> 
pub fn session_revoke_request_to_json(
  session_revoke_request: SessionRevokeRequest,
) -> json.Json

session_revoke_response_decoder

</> 
pub fn session_revoke_response_decoder() -> decode.Decoder(
  SessionRevokeResponse,
)

session_revoke_response_to_json

</> 
pub fn session_revoke_response_to_json(
  session_revoke_response: SessionRevokeResponse,
) -> json.Json

session_token_authenticate_request_decoder

</> 
pub fn session_token_authenticate_request_decoder() -> decode.Decoder(
  SessionTokenAuthenticateRequest,
)

session_token_authenticate_request_to_json

</> 
pub fn session_token_authenticate_request_to_json(
  session_token_authenticate_request: SessionTokenAuthenticateRequest,
) -> json.Json

stytch_client_error_decoder

</> 
pub fn stytch_client_error_decoder() -> decode.Decoder(
  StytchClientError,
)

stytch_client_error_to_json

</> 
pub fn stytch_client_error_to_json(
  stytch_client_error: StytchClientError,
) -> json.Json

stytch_user_decoder

</> 
pub fn stytch_user_decoder() -> decode.Decoder(StytchUser)

stytch_user_to_json

</> 
pub fn stytch_user_to_json(stytch_user: StytchUser) -> json.Json

token_authenticate_request_decoder

</> 
pub fn token_authenticate_request_decoder() -> decode.Decoder(
  TokenAuthenticateRequest,
)

token_authenticate_request_to_json

</> 
pub fn token_authenticate_request_to_json(
  token_authenticate_request: TokenAuthenticateRequest,
) -> json.Json
✨ Search Document