package
1.6.7
Repository: https://github.com/proxeusapp/proxeus-core.git
Documentation: pkg.go.dev

# Functions

Returns the app.html file.
Returns a user by ID.
Lists all users.
Update a user's metadata.
Returns a string in plaintext, containing the message to be signed.
Update a users' e-mail address @param tokenID => string => Request token @returns 200 => OK 400 => Token request not found 417 => Data layer error }.
Start a users email change request @param tokenRequest => { Email string `json:"email" validate:"email=true,required=true"` Token string `json:"token"` UserID string `json:"userID"` Role Role `json:"role"` Type TokenType `json:"type"` } @returns 200 => OK 401 => Unauthorized 417 => E-Mail error 422 => Input error 500 => Token error }.
Check if a payment is required for current user for the workflow.
Returns an object containing the following config parameters { roles => string[] => Possible User Roles blockchainNet => string => Settings.BlockchainNet blockchainProxeusFSAddress => string => Settings.BlockchainContractAddress version => string => Proxeus version }.
Remove the users' auth session @params => { name => string, ID => string, } @returns 200 => apiKey string 400 => Data layer error/Validation error 401 => Unauthorized.
Remove the users' auth session @params => { ID => string, } @returns 200 => apiKey string 400 => Data layer error 401 => Unauthorized.
Ends the context's session and returns 200 => OK in any case.
Update a document with data @params ID => string FormInput => map[string]interface{} @returns 200 => OK 400 => Bad request 422 => Unprocessable entity 500 => Server error.
Delete a document @params ID => string @returns 200 => OK 400 => Bad request.
Update a document @params ID => string, FormInput => interface{} @returns 200 => OK 400 => Bad request 422 => Unprocessable entity.
Returns a document's file output @params ID => string inputName => string @returns 200 => map[string]interface{} 404 => Not found.
Attach a file to a document @params @Fileinput ID => string inputName => string.
Process a document @params ID => string @returns 200 => map[string]interface{}{"name" => string, "status" => string} 400 => Bad request 404 => Not found 422 => Unprocessable entity 500 => Server error.
Move one step further in the document process @params ID => string final => boolean, FormInput => map[string]interface{} @returns 200 => map[string]interface{} 400 => Bad request 401 => Unauthorized 422 => Unprocessable entity.
Move one step back in the document process @params ID => string @returns 200 => status => string 400 => Bad request.
Returns a preview of the document in PDF form.
Helper function for all exports @returns 200 => File 400 => Bad Request 422 => Input error }.
Export platform settings @returns 200 => File 400 => Bad Request 422 => Input error }.
Export a user record @params contains string id string @returns 200 => File 400 => Bad Request 422 => Input error }.
Exports user data @params contains string id string @returns 200 => File 400 => Bad Request 401 => StatusUnauthorized 422 => Input error }.
Returns the config of an external node.
Update the config of an external store.
Instantiate an external node and return the config URL.
List external nodes.
Register an external node @param node => { ID string `json:"id" storm:"id"` Name string `json:"name"` Detail string `json:"detail"` Url string `json:"url"` Secret string `json:"secret"` }.
Returns custom css style if exists @returns 200 => string 500 => Server error.
Returns exported entities @params include string EntityType []string @returns 200 => File 400 => Bad Request 422 => Input error }.
Returns the last exported records stored in the user session @params @returns 200 => imexResults 401 => StatusUnauthorized }.
Returns the last imported records from the user session @params delete boolean @returns 200 => imex results 401 => Unauthorized }.
Returns the platform settings and the "configured" flag that defines whether the user is configured or not @returns 200 => map[string]interface{}{"settings": settings, "configured": configured} 500 => Server error }.
Returns a profile photo @params id => string @returns 200 => File 404 => Not found }.
Returns an object containing { token => string => Session ID }.
No description provided by the author
Invite a user @params TokenRequest struct { Email string `json:"email" validate:"email=true,required=true"` Token string `json:"token"` UserID string `json:"userID"` Role Role `json:"role"` Type TokenType `json:"type"` } @returns 200 => OK 422 => unprocessable entity 500 => Server error }.
Create an auth session @params => { Signature string Name string `json:"name" form:"name"` Email string `json:"email" form:"email"` Password string `json:"password" form:"password"` Address string `json:"address" form:"address"` } @returns 200 => OK => { "location": redirectAfterLogin(user.Role, string(referer)), "created": created, } 400 => Auth error }.
Remove the users' auth session @params => nil @returns 200 => OK => { "location": "/" }.
Returns the user object from the session @params => - @returns 200 => User => {} 404 => Not found }.
Returns the user object from the session @params => - @returns 200 => User => {} 404 => Not found.
Imports a file containing exported entities @params skipExisting string File File (in body) @returns 200 => OK 400 => Bad Request 422 => Input error }.
Initialize the system @params initStruct => struct { Settings *model.Settings `json:"settings"` User *usr `json:"user"` } @returns 200 => OK 422 => unprocessable entity 500 => Server error }.
Returns the frontend.html file.
Returns the user object from the session @params => - @returns 200 => User => {} 404 => Not found.
No description provided by the author
Persists a registration request @params => { string => token string => password } @returns 200 => OK 417 => Token not found/User not found/Data Layer error 422 => Input validation error }.
Handles a registration request @params => { Email string `json:"email" validate:"email=true,required=true"` Token string `json:"token"` UserID string `json:"userID"` Role Role `json:"role"` Type TokenType `json:"type"` } @returns 200 => OK 417 => E-Mail error 422 => Input validation error 500 => Data layer error }.
Reset a users' password @params => string => tokenID @returns 200 => OK 417 => Data layer error 422 => Input validation error }.
Start a user password change request @params => { Email string `json:"email" validate:"email=true,required=true"` Token string `json:"token"` UserID string `json:"userID"` Role Role `json:"role"` Type TokenType `json:"type"` } @returns 200 => OK 400 => Token request not found 417 => E-Mail error 422 => Input validation error 500 => Token error }.
Returns the app.html file.
root only feature to switch user by address - useful for permission checks.
Update a users' blockchain address @param loginForm => { Signature string Name string `json:"name" form:"name"` Email string `json:"email" form:"email"` Password string `json:"password" form:"password"` Address string `json:"address" form:"address"` } @returns 200 => OK 401 => Unauthorized 422 => Challenge error/Signature error 500 => User not found }.
Returns the user.html file.
Remove a user from the database.
Returns a file belonging to a users document.
Returns a documents metadata.
Returns a list of paginated user documents.
Add a signature request for a document.
Returns a signature request based on a provided document ID.
Returns a signature request for the current user.
Reject a signature request for a document.
Revoke a documents signature.
Validates user session cookie.
Execute a workflow at once.
Returns a workflows schema.

# Structs

No description provided by the author
No description provided by the author