AuthApi.md

mosquito_alert.api.AuthApi

Load the API package

import 'package:mosquito_alert/api.dart';

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

Method	HTTP request	Description
changePassword	POST /auth/password/change/
obtainToken	POST /auth/token/
refreshToken	POST /auth/token/refresh/
signupGuest	POST /auth/signup/guest/
verifyToken	POST /auth/token/verify/

changePassword

changePassword(passwordChangeRequest)

Example

import 'package:mosquito_alert/api.dart';

final api = MosquitoAlert().getAuthApi();
final PasswordChangeRequest passwordChangeRequest = ; // PasswordChangeRequest | 

try {
    api.changePassword(passwordChangeRequest);
} catch on DioException (e) {
    print('Exception when calling AuthApi->changePassword: $e\n');
}

Parameters

Name	Type	Description	Notes
passwordChangeRequest	PasswordChangeRequest

Return type

void (empty response body)

Authorization

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]

obtainToken

AppUserTokenObtainPair obtainToken(appUserTokenObtainPairRequest)

Takes a set of user credentials and returns an access and refresh JSON web token pair to prove the authentication of those credentials.

Example

import 'package:mosquito_alert/api.dart';

final api = MosquitoAlert().getAuthApi();
final AppUserTokenObtainPairRequest appUserTokenObtainPairRequest = ; // AppUserTokenObtainPairRequest | 

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

Parameters

Name	Type	Description	Notes
appUserTokenObtainPairRequest	AppUserTokenObtainPairRequest

Return type

AppUserTokenObtainPair

Authorization

No authorization required

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]

refreshToken

TokenRefresh refreshToken(tokenRefreshRequest)

Takes a refresh type JSON web token and returns an access type JSON web token if the refresh token is valid.

Example

import 'package:mosquito_alert/api.dart';

final api = MosquitoAlert().getAuthApi();
final TokenRefreshRequest tokenRefreshRequest = ; // TokenRefreshRequest | 

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

Parameters

Name	Type	Description	Notes
tokenRefreshRequest	TokenRefreshRequest

Return type

TokenRefresh

Authorization

No authorization required

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]

signupGuest

GuestRegistration signupGuest(guestRegistrationRequest)

Example

import 'package:mosquito_alert/api.dart';

final api = MosquitoAlert().getAuthApi();
final GuestRegistrationRequest guestRegistrationRequest = ; // GuestRegistrationRequest | 

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

Parameters

Name	Type	Description	Notes
guestRegistrationRequest	GuestRegistrationRequest

Return type

GuestRegistration

Authorization

No authorization required

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]

verifyToken

verifyToken(tokenVerifyRequest)

Takes a token and indicates if it is valid. This view provides no information about a token's fitness for a particular use.

Example

import 'package:mosquito_alert/api.dart';

final api = MosquitoAlert().getAuthApi();
final TokenVerifyRequest tokenVerifyRequest = ; // TokenVerifyRequest | 

try {
    api.verifyToken(tokenVerifyRequest);
} catch on DioException (e) {
    print('Exception when calling AuthApi->verifyToken: $e\n');
}

Parameters

Name	Type	Description	Notes
tokenVerifyRequest	TokenVerifyRequest

Return type

void (empty response body)

Authorization

No authorization required

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]