Skip to content

Latest commit

 

History

History
219 lines (155 loc) · 6.13 KB

UsersApi.md

File metadata and controls

219 lines (155 loc) · 6.13 KB

UsersApi

All URIs are relative to https://api.mosquitoalert.com/v1

Method HTTP request Description
partial_update PATCH /users/{uuid}/
retrieve GET /users/{uuid}/
retrieve_mine GET /me/
update PUT /users/{uuid}/

partial_update

User partial_update(uuid, patched_user_request = var.patched_user_request)

Example

library(MosquitoAlert)

# prepare function argument(s)
var_uuid <- "uuid_example" # character | 
var_patched_user_request <- PatchedUserRequest$new("es") # PatchedUserRequest |  (Optional)

api_instance <- mosquitoalert_api$new()
# Configure API key authorization: cookieAuth
api_instance$api_client$api_keys["sessionid"] <- Sys.getenv("API_KEY")
# Configure API key authorization: tokenAuth
# api_instance$api_client$api_keys["Authorization"] <- Sys.getenv("API_KEY")
# Configure HTTP bearer authorization: jwtAuth
# api_instance$api_client$bearer_token <- Sys.getenv("BEARER_TOKEN")
# to save the result into a file, simply add the optional `data_file` parameter, e.g.
# result <- api_instance$partial_update(var_uuid, patched_user_request = var_patched_user_requestdata_file = "result.txt")
result <- api_instance$users_api$partial_update(var_uuid, patched_user_request = var_patched_user_request)
dput(result)

Parameters

Name Type Description Notes
uuid character
patched_user_request PatchedUserRequest [optional]

Return type

User

Authorization

cookieAuth, tokenAuth, jwtAuth

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
  • Accept: application/json

HTTP response details

Status code Description Response headers
400 -
401 -
403 -
404 -
200 -

retrieve

User retrieve(uuid)

Example

library(MosquitoAlert)

# prepare function argument(s)
var_uuid <- "uuid_example" # character | 

api_instance <- mosquitoalert_api$new()
# Configure API key authorization: cookieAuth
api_instance$api_client$api_keys["sessionid"] <- Sys.getenv("API_KEY")
# Configure API key authorization: tokenAuth
# api_instance$api_client$api_keys["Authorization"] <- Sys.getenv("API_KEY")
# Configure HTTP bearer authorization: jwtAuth
# api_instance$api_client$bearer_token <- Sys.getenv("BEARER_TOKEN")
# to save the result into a file, simply add the optional `data_file` parameter, e.g.
# result <- api_instance$retrieve(var_uuiddata_file = "result.txt")
result <- api_instance$users_api$retrieve(var_uuid)
dput(result)

Parameters

Name Type Description Notes
uuid character

Return type

User

Authorization

cookieAuth, tokenAuth, jwtAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
401 -
403 -
404 -
200 -

retrieve_mine

User retrieve_mine()

Get Current User's Profile

Example

library(MosquitoAlert)


api_instance <- mosquitoalert_api$new()
# Configure HTTP bearer authorization: jwtAuth
api_instance$api_client$bearer_token <- Sys.getenv("BEARER_TOKEN")
# to save the result into a file, simply add the optional `data_file` parameter, e.g.
# result <- api_instance$retrieve_mine(data_file = "result.txt")
result <- api_instance$users_api$retrieve_mine()
dput(result)

Parameters

This endpoint does not need any parameter.

Return type

User

Authorization

jwtAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
401 -
403 -
404 -
200 -

update

User update(uuid, user_request = var.user_request)

Example

library(MosquitoAlert)

# prepare function argument(s)
var_uuid <- "uuid_example" # character | 
var_user_request <- UserRequest$new("es") # UserRequest |  (Optional)

api_instance <- mosquitoalert_api$new()
# Configure API key authorization: cookieAuth
api_instance$api_client$api_keys["sessionid"] <- Sys.getenv("API_KEY")
# Configure API key authorization: tokenAuth
# api_instance$api_client$api_keys["Authorization"] <- Sys.getenv("API_KEY")
# Configure HTTP bearer authorization: jwtAuth
# api_instance$api_client$bearer_token <- Sys.getenv("BEARER_TOKEN")
# to save the result into a file, simply add the optional `data_file` parameter, e.g.
# result <- api_instance$update(var_uuid, user_request = var_user_requestdata_file = "result.txt")
result <- api_instance$users_api$update(var_uuid, user_request = var_user_request)
dput(result)

Parameters

Name Type Description Notes
uuid character
user_request UserRequest [optional]

Return type

User

Authorization

cookieAuth, tokenAuth, jwtAuth

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
  • Accept: application/json

HTTP response details

Status code Description Response headers
400 -
401 -
403 -
404 -
200 -