contracts

type AuthRequestPayload struct {
	// Email Email address
	Email Email `json:"email"`

	// IsRememberMe Extend token expiration
	IsRememberMe *bool `json:"isRememberMe,omitempty"`

	// Password Password (minimum 8 characters)
	Password Password `json:"password"`
}

type AuthTokenRefreshRequestPayload struct {
	// RefreshToken JWT refresh token
	RefreshToken string `json:"refreshToken"`
}

type AuthenticateUser200JSONResponse struct {
	// AccessToken JWT access token
	AccessToken string `json:"accessToken"`

	// AccessTokenExpiresInSeconds Access token expiration time in seconds
	AccessTokenExpiresInSeconds int `json:"accessTokenExpiresInSeconds"`

	// RefreshToken JWT refresh token
	RefreshToken string `json:"refreshToken"`

	// RefreshTokenExpiresInSeconds Refresh token expiration time in seconds
	RefreshTokenExpiresInSeconds int `json:"refreshTokenExpiresInSeconds"`

	// User User entity representing a system user
	User User `json:"user"`
}

type AuthenticateUser400JSONResponse Error

type AuthenticateUser401JSONResponse Error

type AuthenticateUserJSONRequestBody = AuthRequestPayload

type AuthenticateUserRequestObject struct {
	Body *AuthenticateUserJSONRequestBody
}

type AuthenticateUserResponseObject interface {
	VisitAuthenticateUserResponse(w http.ResponseWriter) error
}

type AvatarUrl = string

type ChiServerOptions struct {
	BaseURL          string
	BaseRouter       chi.Router
	Middlewares      []MiddlewareFunc
	ErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)
}

type CreateUser201JSONResponse User

type CreateUser400JSONResponse Error

type CreateUser401JSONResponse Error

type CreateUser409JSONResponse Error

type CreateUserJSONRequestBody = UserCreateRequest

type CreateUserRequestObject struct {
	Body *CreateUserJSONRequestBody
}

type CreateUserResponseObject interface {
	VisitCreateUserResponse(w http.ResponseWriter) error
}

type DeleteUserById200JSONResponse struct {
	Success *bool `json:"success,omitempty"`
}

type DeleteUserById400JSONResponse Error

type DeleteUserById401JSONResponse Error

type DeleteUserById404JSONResponse Error

type DeleteUserByIdRequestObject struct {
	UserId UserId `json:"userId"`
}

type DeleteUserByIdResponseObject interface {
	VisitDeleteUserByIdResponse(w http.ResponseWriter) error
}

type Email = openapi_types.Email

type Error struct {
	// Code - ERR_ACCESS_DENIED: Access denied. Usually that error can occur when the user is not authorized to perform the operation (e.g. buyer tries to remove admin or buyer tries to add a new user). Mostly theoretical error.
	// - ERR_ALREADY_EXISTS: The record already exists in the system. Usually that error can occur during adding users, that were already added to the system.
	// - ERR_ALREADY_VERIFIED: The request was already verified. Usually that error can occur during verification of the code, that was already verified.
	// - ERR_AUTH_CODE_INVALID: The provided auth code is invalid. Usually that error can occur during verification of the auth code, that is invalid.
	// - ERR_INSUFFICIENT_FUNDS: Insufficient funds. Usually that error can occur during moving (transferring, withdrawing) funds from the account or card, when the source doesn't have enough of funds.
	// - ERR_INTERNAL: Internal server error. Usually that error indicates some general internal server error, that has nothing to do with client's data, so it can be used with 500 http code.
	// - ERR_INVALID_ARG: Invalid argument(s) was (were) provided during the request. Usually that error can occur when one or more arguments (or their combination) were provided in incorrect format or the operation with the given arguments is prohibited (e.g. you can't delete the general account). Usually that error could be eliminated by calling another endpoint in advance, that provides correct values (or options) to call the former endpoint.
	// - ERR_INVALID_CREDENTIALS: Invalid credentials were provided during the request. Usually that error can occur during providing invalid password and/or email.
	// - ERR_NOT_FOUND: The resource was not found. Usually that error can occur during requesting the resource, that was already removed and can't be accessed anymore (e.g. requesting deleted transaction/user/account information).
	// - ERR_WEAK_PASSWORD: Weak password. Usually that error can occur during providing too weak password for sign up or update password processes. That error should not be the case for web clients, since the password weakness is validated on the FE, so if you encountered that error, probably the FE and the BE are not aligned properly with each other.
	// - ERR_CONTACT_SUPPORT: Some error occurred that needs to be escalated to support. That might signal that liquidity is low.
	// - ERR_SELF_TRANSFER: It is not allowed to transfer funds from an account to itself.
	Code ErrorCode `json:"code"`

	// Details Additional error details
	Details *map[string]interface{} `json:"details,omitempty"`

	// Message Human-readable error message
	Message *string `json:"message,omitempty"`

	// Timestamp Error occurrence timestamp
	Timestamp *time.Time `json:"timestamp,omitempty"`
}

type ErrorCode string

type GetHealthStatus200JSONResponse struct {
	Status    *string    `json:"status,omitempty"`
	Timestamp *time.Time `json:"timestamp,omitempty"`
	Version   *string    `json:"version,omitempty"`
}

type GetHealthStatus500JSONResponse Error

type GetHealthStatusRequestObject struct {
}

type GetHealthStatusResponseObject interface {
	VisitGetHealthStatusResponse(w http.ResponseWriter) error
}

type GetUserById200JSONResponse User

type GetUserById400JSONResponse Error

type GetUserById401JSONResponse Error

type GetUserById404JSONResponse Error

type GetUserByIdRequestObject struct {
	UserId UserId `json:"userId"`
}

type GetUserByIdResponseObject interface {
	VisitGetUserByIdResponse(w http.ResponseWriter) error
}

type GetUserList200JSONResponse struct {
	Data *[]User `json:"data,omitempty"`

	// Meta Pagination metadata for list responses
	Meta *PaginationMeta `json:"meta,omitempty"`
}

type GetUserList400JSONResponse Error

type GetUserList401JSONResponse Error

type GetUserListParams struct {
	// UsersRequestPayload Filter, sort and pagination query to fetch records.
	UsersRequestPayload UsersRequestPayload `form:"UsersRequestPayload" json:"UsersRequestPayload"`
}

type GetUserListRequestObject struct {
	Params GetUserListParams
}

type GetUserListResponseObject interface {
	VisitGetUserListResponse(w http.ResponseWriter) error
}

type Id = openapi_types.UUID

type InvalidParamFormatError struct {
	ParamName string
	Err       error
}

type Limit = int

type LogoutUser200JSONResponse struct {
	Success *bool `json:"success,omitempty"`
}

type LogoutUser401JSONResponse Error

type LogoutUserRequestObject struct {
}

type LogoutUserResponseObject interface {
	VisitLogoutUserResponse(w http.ResponseWriter) error
}

type MiddlewareFunc func(http.Handler) http.Handler

type Name = string

type Order string

type OrderBy = []Order

type PaginationMeta struct {
	// Limit Number of items per page
	Limit int `json:"limit"`

	// Offset Offset of records to skip
	Offset int `json:"offset"`

	// Total Total number of items
	Total int `json:"total"`
}

type PaginationOffset = int

type Password = string

type RefreshTokens200JSONResponse TokenResponse

type RefreshTokens400JSONResponse Error

type RefreshTokens401JSONResponse Error

type RefreshTokensJSONRequestBody = AuthTokenRefreshRequestPayload

type RefreshTokensRequestObject struct {
	Body *RefreshTokensJSONRequestBody
}

type RefreshTokensResponseObject interface {
	VisitRefreshTokensResponse(w http.ResponseWriter) error
}

type RegisterRequestPayload struct {
	// Email Email address
	Email Email `json:"email"`

	// FirstName Name (either first name or last name) of the user.
	FirstName Name `json:"firstName"`

	// LastName Name (either first name or last name) of the user.
	LastName Name `json:"lastName"`

	// Password Password (minimum 8 characters)
	Password Password `json:"password"`
}

type RegisterUser201JSONResponse struct {
	// AccessToken JWT access token
	AccessToken string `json:"accessToken"`

	// AccessTokenExpiresInSeconds Access token expiration time in seconds
	AccessTokenExpiresInSeconds int `json:"accessTokenExpiresInSeconds"`

	// RefreshToken JWT refresh token
	RefreshToken string `json:"refreshToken"`

	// RefreshTokenExpiresInSeconds Refresh token expiration time in seconds
	RefreshTokenExpiresInSeconds int `json:"refreshTokenExpiresInSeconds"`

	// User User entity representing a system user
	User User `json:"user"`
}

type RegisterUser400JSONResponse Error

type RegisterUser409JSONResponse Error

type RegisterUserJSONRequestBody = RegisterRequestPayload

type RegisterUserRequestObject struct {
	Body *RegisterUserJSONRequestBody
}

type RegisterUserResponseObject interface {
	VisitRegisterUserResponse(w http.ResponseWriter) error
}

type RequiredHeaderError struct {
	ParamName string
	Err       error
}

type RequiredParamError struct {
	ParamName string
}

type ServerInterface interface {
	// User login
	// (POST /v1/auth/login)
	AuthenticateUser(w http.ResponseWriter, r *http.Request)
	// User logout
	// (POST /v1/auth/logout)
	LogoutUser(w http.ResponseWriter, r *http.Request)
	// Refresh tokens
	// (POST /v1/auth/refresh)
	RefreshTokens(w http.ResponseWriter, r *http.Request)
	// Register new user
	// (POST /v1/auth/register)
	RegisterUser(w http.ResponseWriter, r *http.Request)
	// Health check
	// (GET /v1/health)
	GetHealthStatus(w http.ResponseWriter, r *http.Request)
	// List users
	// (GET /v1/users)
	GetUserList(w http.ResponseWriter, r *http.Request, params GetUserListParams)
	// Create user
	// (POST /v1/users)
	CreateUser(w http.ResponseWriter, r *http.Request)
	// Delete user
	// (DELETE /v1/users/{userId})
	DeleteUserById(w http.ResponseWriter, r *http.Request, userId UserId)
	// Get user by ID
	// (GET /v1/users/{userId})
	GetUserById(w http.ResponseWriter, r *http.Request, userId UserId)
	// Update user
	// (PUT /v1/users/{userId})
	UpdateUserById(w http.ResponseWriter, r *http.Request, userId UserId)
	// Update user email
	// (PUT /v1/users/{userId}/email)
	UpdateUserEmail(w http.ResponseWriter, r *http.Request, userId UserId)
}

type ServerInterfaceWrapper struct {
	Handler            ServerInterface
	HandlerMiddlewares []MiddlewareFunc
	ErrorHandlerFunc   func(w http.ResponseWriter, r *http.Request, err error)
}

type StrictHTTPServerOptions struct {
	RequestErrorHandlerFunc  func(w http.ResponseWriter, r *http.Request, err error)
	ResponseErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)
}

type StrictHandlerFunc = strictnethttp.StrictHTTPHandlerFunc

type StrictMiddlewareFunc = strictnethttp.StrictHTTPMiddlewareFunc

type StrictServerInterface interface {
	// User login
	// (POST /v1/auth/login)
	AuthenticateUser(ctx context.Context, request AuthenticateUserRequestObject) (AuthenticateUserResponseObject, error)
	// User logout
	// (POST /v1/auth/logout)
	LogoutUser(ctx context.Context, request LogoutUserRequestObject) (LogoutUserResponseObject, error)
	// Refresh tokens
	// (POST /v1/auth/refresh)
	RefreshTokens(ctx context.Context, request RefreshTokensRequestObject) (RefreshTokensResponseObject, error)
	// Register new user
	// (POST /v1/auth/register)
	RegisterUser(ctx context.Context, request RegisterUserRequestObject) (RegisterUserResponseObject, error)
	// Health check
	// (GET /v1/health)
	GetHealthStatus(ctx context.Context, request GetHealthStatusRequestObject) (GetHealthStatusResponseObject, error)
	// List users
	// (GET /v1/users)
	GetUserList(ctx context.Context, request GetUserListRequestObject) (GetUserListResponseObject, error)
	// Create user
	// (POST /v1/users)
	CreateUser(ctx context.Context, request CreateUserRequestObject) (CreateUserResponseObject, error)
	// Delete user
	// (DELETE /v1/users/{userId})
	DeleteUserById(ctx context.Context, request DeleteUserByIdRequestObject) (DeleteUserByIdResponseObject, error)
	// Get user by ID
	// (GET /v1/users/{userId})
	GetUserById(ctx context.Context, request GetUserByIdRequestObject) (GetUserByIdResponseObject, error)
	// Update user
	// (PUT /v1/users/{userId})
	UpdateUserById(ctx context.Context, request UpdateUserByIdRequestObject) (UpdateUserByIdResponseObject, error)
	// Update user email
	// (PUT /v1/users/{userId}/email)
	UpdateUserEmail(ctx context.Context, request UpdateUserEmailRequestObject) (UpdateUserEmailResponseObject, error)
}

type TokenResponse struct {
	// AccessToken JWT access token
	AccessToken string `json:"accessToken"`

	// AccessTokenExpiresInSeconds Access token expiration time in seconds
	AccessTokenExpiresInSeconds int `json:"accessTokenExpiresInSeconds"`

	// RefreshToken JWT refresh token
	RefreshToken string `json:"refreshToken"`

	// RefreshTokenExpiresInSeconds Refresh token expiration time in seconds
	RefreshTokenExpiresInSeconds int `json:"refreshTokenExpiresInSeconds"`
}

type TooManyValuesForParamError struct {
	ParamName string
	Count     int
}

type UnescapedCookieParamError struct {
	ParamName string
	Err       error
}

type Unimplemented struct{}

type UnmarshalingParamError struct {
	ParamName string
	Err       error
}

type UpdateUserById200JSONResponse User

type UpdateUserById400JSONResponse Error

type UpdateUserById401JSONResponse Error

type UpdateUserById404JSONResponse Error

type UpdateUserByIdJSONRequestBody = UserUpdateRequest

type UpdateUserByIdRequestObject struct {
	UserId UserId `json:"userId"`
	Body   *UpdateUserByIdJSONRequestBody
}

type UpdateUserByIdResponseObject interface {
	VisitUpdateUserByIdResponse(w http.ResponseWriter) error
}

type UpdateUserEmail200JSONResponse User

type UpdateUserEmail400JSONResponse Error

type UpdateUserEmail401JSONResponse Error

type UpdateUserEmail403JSONResponse Error

type UpdateUserEmail404JSONResponse Error

type UpdateUserEmailJSONRequestBody = UserUpdateEmailRequest

type UpdateUserEmailRequestObject struct {
	UserId UserId `json:"userId"`
	Body   *UpdateUserEmailJSONRequestBody
}

type UpdateUserEmailResponseObject interface {
	VisitUpdateUserEmailResponse(w http.ResponseWriter) error
}

type User struct {
	// AvatarUrl User avatar URL
	AvatarUrl *AvatarUrl `json:"avatarUrl"`

	// CreatedAt Creation timestamp
	CreatedAt time.Time `json:"createdAt"`

	// Email Email address
	Email Email `json:"email"`

	// FirstName Name (either first name or last name) of the user.
	FirstName Name `json:"firstName"`

	// Id Unique identifier
	Id Id `json:"id"`

	// LastLoginAt Last login timestamp
	LastLoginAt *time.Time `json:"lastLoginAt"`

	// LastName Name (either first name or last name) of the user.
	LastName Name `json:"lastName"`

	// Role Profile role.
	Role UserRole `json:"role"`

	// Status User status.
	// - ACTIVE: The user is currently active and operational.
	// - PENDING: User has been invited but not yet activated by the user.
	// - FROZEN: The user is inactive and not available for transactions.
	// - DELETED: The user has been deleted and is no longer active.
	Status UserStatus `json:"status"`

	// UpdatedAt Last update timestamp
	UpdatedAt time.Time `json:"updatedAt"`
}

type UserCreateRequest struct {
	// Email Email address
	Email Email `json:"email"`

	// FirstName Name (either first name or last name) of the user.
	FirstName Name `json:"firstName"`

	// LastName Name (either first name or last name) of the user.
	LastName Name `json:"lastName"`

	// Password Password (minimum 8 characters)
	Password Password `json:"password"`

	// Role Profile role.
	Role *UserRole `json:"role,omitempty"`

	// Status User status.
	// - ACTIVE: The user is currently active and operational.
	// - PENDING: User has been invited but not yet activated by the user.
	// - FROZEN: The user is inactive and not available for transactions.
	// - DELETED: The user has been deleted and is no longer active.
	Status *UserStatus `json:"status,omitempty"`
}

type UserId = openapi_types.UUID

type UserRole string

type UserSortField string

type UserStatus string

type UserUpdateEmailRequest struct {
	// NewEmail Email address
	NewEmail Email `json:"newEmail"`

	// Password Password (minimum 8 characters)
	Password Password `json:"password"`
}

type UserUpdateRequest struct {
	// AvatarUrl User avatar URL
	AvatarUrl *AvatarUrl `json:"avatarUrl"`

	// FirstName Name (either first name or last name) of the user.
	FirstName *Name `json:"firstName,omitempty"`

	// LastName Name (either first name or last name) of the user.
	LastName *Name `json:"lastName,omitempty"`

	// Role Profile role.
	Role *UserRole `json:"role,omitempty"`

	// Status User status.
	// - ACTIVE: The user is currently active and operational.
	// - PENDING: User has been invited but not yet activated by the user.
	// - FROZEN: The user is inactive and not available for transactions.
	// - DELETED: The user has been deleted and is no longer active.
	Status *UserStatus `json:"status,omitempty"`
}

type UsersRequestPayload struct {
	// Filter Filter criteria for selecting records.
	Filter *struct {
		// Roles Filter by user roles.
		Roles *[]UserRole `json:"roles,omitempty"`

		// Statuses Filter by user statuses.
		Statuses *[]UserStatus `json:"statuses,omitempty"`

		// Text Full text search.
		Text *string `json:"text,omitempty"`
	} `json:"filter,omitempty"`

	// Limit Limit of records count to return.
	Limit Limit `json:"limit"`

	// Offset Offset of records to skip.
	Offset PaginationOffset `json:"offset"`

	// OrderBy Order of sorting (ascending/descending). `sortBy` and `orderBy` arrays have always the same length, and each element or `sortBy` array corresponds to the appropriate element of `orderBy` array.
	OrderBy *OrderBy `json:"orderBy,omitempty"`

	// SortBy Fields to sort the results by.
	SortBy *[]UserSortField `json:"sortBy,omitempty"`
}