Skip to content

AuthApi.md

Latest commit

 

History

History
520 lines (337 loc) · 13.7 KB

AuthApi.md

File metadata and controls

520 lines (337 loc) · 13.7 KB

dart_sdk.api.AuthApi

Load the API package

import 'package:dart_sdk/api.dart';

All URIs are relative to https://api.techcell.cloud

Method HTTP request Description
authControllerConfirmEmail POST /api/auth/email/confirm
authControllerForgotPassword POST /api/auth/forgot/password
authControllerGetMe GET /api/auth/me
authControllerLogin POST /api/auth/email/login
authControllerLogout POST /api/auth/logout
authControllerRefresh POST /api/auth/refresh
authControllerRegister POST /api/auth/email/register
authControllerResendConfirmEmail POST /api/auth/email/resend-confirm
authControllerResetPassword POST /api/auth/reset/password
authControllerUpdateMe PATCH /api/auth/me
authFacebookControllerLogin POST /api/auth/facebook/login
authGoogleControllerLogin POST /api/auth/google/login

authControllerConfirmEmail

authControllerConfirmEmail(authConfirmEmailDto)

Example

import 'package:dart_sdk/api.dart';

final api_instance = AuthApi();
final authConfirmEmailDto = AuthConfirmEmailDto(); // AuthConfirmEmailDto | 

try {
    api_instance.authControllerConfirmEmail(authConfirmEmailDto);
} catch (e) {
    print('Exception when calling AuthApi->authControllerConfirmEmail: $e\n');
}

Parameters

Name Type Description Notes
authConfirmEmailDto AuthConfirmEmailDto

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

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

authControllerForgotPassword

authControllerForgotPassword(authForgotPasswordDto)

Example

import 'package:dart_sdk/api.dart';

final api_instance = AuthApi();
final authForgotPasswordDto = AuthForgotPasswordDto(); // AuthForgotPasswordDto | 

try {
    api_instance.authControllerForgotPassword(authForgotPasswordDto);
} catch (e) {
    print('Exception when calling AuthApi->authControllerForgotPassword: $e\n');
}

Parameters

Name Type Description Notes
authForgotPasswordDto AuthForgotPasswordDto

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

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

authControllerGetMe

User authControllerGetMe()

Example

import 'package:dart_sdk/api.dart';
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken(yourTokenGeneratorFunction);

final api_instance = AuthApi();

try {
    final result = api_instance.authControllerGetMe();
    print(result);
} catch (e) {
    print('Exception when calling AuthApi->authControllerGetMe: $e\n');
}

Parameters

This endpoint does not need any parameter.

Return type

User

Authorization

bearer

HTTP request headers

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

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

authControllerLogin

LoginResponseDto authControllerLogin(authEmailLoginDto)

Example

import 'package:dart_sdk/api.dart';

final api_instance = AuthApi();
final authEmailLoginDto = AuthEmailLoginDto(); // AuthEmailLoginDto | 

try {
    final result = api_instance.authControllerLogin(authEmailLoginDto);
    print(result);
} catch (e) {
    print('Exception when calling AuthApi->authControllerLogin: $e\n');
}

Parameters

Name Type Description Notes
authEmailLoginDto AuthEmailLoginDto

Return type

LoginResponseDto

Authorization

No authorization required

HTTP request headers

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

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

authControllerLogout

authControllerLogout()

Example

import 'package:dart_sdk/api.dart';
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken(yourTokenGeneratorFunction);

final api_instance = AuthApi();

try {
    api_instance.authControllerLogout();
} catch (e) {
    print('Exception when calling AuthApi->authControllerLogout: $e\n');
}

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

authControllerRefresh

RefreshTokenResponseDto authControllerRefresh(refreshTokenDto)

Example

import 'package:dart_sdk/api.dart';

final api_instance = AuthApi();
final refreshTokenDto = RefreshTokenDto(); // RefreshTokenDto | 

try {
    final result = api_instance.authControllerRefresh(refreshTokenDto);
    print(result);
} catch (e) {
    print('Exception when calling AuthApi->authControllerRefresh: $e\n');
}

Parameters

Name Type Description Notes
refreshTokenDto RefreshTokenDto

Return type

RefreshTokenResponseDto

Authorization

No authorization required

HTTP request headers

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

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

authControllerRegister

authControllerRegister(authSignupDto)

Example

import 'package:dart_sdk/api.dart';

final api_instance = AuthApi();
final authSignupDto = AuthSignupDto(); // AuthSignupDto | 

try {
    api_instance.authControllerRegister(authSignupDto);
} catch (e) {
    print('Exception when calling AuthApi->authControllerRegister: $e\n');
}

Parameters

Name Type Description Notes
authSignupDto AuthSignupDto

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

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

authControllerResendConfirmEmail

authControllerResendConfirmEmail(resendConfirmEmail)

Example

import 'package:dart_sdk/api.dart';

final api_instance = AuthApi();
final resendConfirmEmail = ResendConfirmEmail(); // ResendConfirmEmail | 

try {
    api_instance.authControllerResendConfirmEmail(resendConfirmEmail);
} catch (e) {
    print('Exception when calling AuthApi->authControllerResendConfirmEmail: $e\n');
}

Parameters

Name Type Description Notes
resendConfirmEmail ResendConfirmEmail

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

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

authControllerResetPassword

authControllerResetPassword(authResetPasswordDto)

Example

import 'package:dart_sdk/api.dart';

final api_instance = AuthApi();
final authResetPasswordDto = AuthResetPasswordDto(); // AuthResetPasswordDto | 

try {
    api_instance.authControllerResetPassword(authResetPasswordDto);
} catch (e) {
    print('Exception when calling AuthApi->authControllerResetPassword: $e\n');
}

Parameters

Name Type Description Notes
authResetPasswordDto AuthResetPasswordDto

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

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

authControllerUpdateMe

authControllerUpdateMe(authUpdateDto)

Example

import 'package:dart_sdk/api.dart';
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken(yourTokenGeneratorFunction);

final api_instance = AuthApi();
final authUpdateDto = AuthUpdateDto(); // AuthUpdateDto | 

try {
    api_instance.authControllerUpdateMe(authUpdateDto);
} catch (e) {
    print('Exception when calling AuthApi->authControllerUpdateMe: $e\n');
}

Parameters

Name Type Description Notes
authUpdateDto AuthUpdateDto

Return type

void (empty response body)

Authorization

bearer

HTTP request headers

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

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

authFacebookControllerLogin

LoginResponseDto authFacebookControllerLogin(authFacebookLoginDto)

Example

import 'package:dart_sdk/api.dart';

final api_instance = AuthApi();
final authFacebookLoginDto = AuthFacebookLoginDto(); // AuthFacebookLoginDto | 

try {
    final result = api_instance.authFacebookControllerLogin(authFacebookLoginDto);
    print(result);
} catch (e) {
    print('Exception when calling AuthApi->authFacebookControllerLogin: $e\n');
}

Parameters

Name Type Description Notes
authFacebookLoginDto AuthFacebookLoginDto

Return type

LoginResponseDto

Authorization

No authorization required

HTTP request headers

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

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

authGoogleControllerLogin

LoginResponseDto authGoogleControllerLogin(authGoogleLoginDto)

Example

import 'package:dart_sdk/api.dart';

final api_instance = AuthApi();
final authGoogleLoginDto = AuthGoogleLoginDto(); // AuthGoogleLoginDto | 

try {
    final result = api_instance.authGoogleControllerLogin(authGoogleLoginDto);
    print(result);
} catch (e) {
    print('Exception when calling AuthApi->authGoogleControllerLogin: $e\n');
}

Parameters

Name Type Description Notes
authGoogleLoginDto AuthGoogleLoginDto

Return type

LoginResponseDto

Authorization

No authorization required

HTTP request headers

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

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