UsersApi.md

mosquito_alert.api.UsersApi

Load the API package

import 'package:mosquito_alert/api.dart';

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

Method	HTTP request	Description
partialUpdate	PATCH /users/{uuid}/
retrieve	GET /users/{uuid}/
retrieveMine	GET /me/
update	PUT /users/{uuid}/

partialUpdate

User partialUpdate(uuid, patchedUserRequest)

Example

import 'package:mosquito_alert/api.dart';
// TODO Configure API key authorization: tokenAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('tokenAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('tokenAuth').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: cookieAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookieAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookieAuth').apiKeyPrefix = 'Bearer';

final api = MosquitoAlert().getUsersApi();
final String uuid = uuid_example; // String | 
final PatchedUserRequest patchedUserRequest = ; // PatchedUserRequest | 

try {
    final response = api.partialUpdate(uuid, patchedUserRequest);
    print(response);
} catch on DioException (e) {
    print('Exception when calling UsersApi->partialUpdate: $e\n');
}

Parameters

Name	Type	Description	Notes
uuid	String
patchedUserRequest	PatchedUserRequest		[optional]

Return type

User

Authorization

tokenAuth, cookieAuth, jwtAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve

User retrieve(uuid)

Example

import 'package:mosquito_alert/api.dart';
// TODO Configure API key authorization: tokenAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('tokenAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('tokenAuth').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: cookieAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookieAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookieAuth').apiKeyPrefix = 'Bearer';

final api = MosquitoAlert().getUsersApi();
final String uuid = uuid_example; // String | 

try {
    final response = api.retrieve(uuid);
    print(response);
} catch on DioException (e) {
    print('Exception when calling UsersApi->retrieve: $e\n');
}

Parameters

Name	Type	Description	Notes
uuid	String

Return type

User

Authorization

tokenAuth, cookieAuth, jwtAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieveMine

User retrieveMine()

Get Current User's Profile

Example

import 'package:mosquito_alert/api.dart';

final api = MosquitoAlert().getUsersApi();

try {
    final response = api.retrieveMine();
    print(response);
} catch on DioException (e) {
    print('Exception when calling UsersApi->retrieveMine: $e\n');
}

Parameters

This endpoint does not need any parameter.

Return type

User

Authorization

jwtAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update

User update(uuid, userRequest)

Example

import 'package:mosquito_alert/api.dart';
// TODO Configure API key authorization: tokenAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('tokenAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('tokenAuth').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: cookieAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookieAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookieAuth').apiKeyPrefix = 'Bearer';

final api = MosquitoAlert().getUsersApi();
final String uuid = uuid_example; // String | 
final UserRequest userRequest = ; // UserRequest | 

try {
    final response = api.update(uuid, userRequest);
    print(response);
} catch on DioException (e) {
    print('Exception when calling UsersApi->update: $e\n');
}

Parameters

Name	Type	Description	Notes
uuid	String
userRequest	UserRequest		[optional]

Return type

User

Authorization

tokenAuth, cookieAuth, jwtAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]