djangoflow_openapi 0.0.23 copy "djangoflow_openapi: ^0.0.23" to clipboard
djangoflow_openapi: ^0.0.23 copied to clipboard

DjangoFlow OpenAPI API Client

djangoflow_openapi (EXPERIMENTAL) #

description

This Dart package is automatically generated by the OpenAPI Generator project:

  • API version: 0.0.1
  • Build package: org.openapitools.codegen.languages.DartDioClientCodegen

Requirements #

Installation & Usage #

pub.dev #

To use the package from pub.dev, please include the following in pubspec.yaml

dependencies:
  djangoflow_openapi: 0.0.23

Github #

If this Dart package is published to Github, please include the following in pubspec.yaml

dependencies:
  djangoflow_openapi:
    git:
      url: https://github.com/GIT_USER_ID/GIT_REPO_ID.git
      #ref: main

Local development #

To use the package from your local drive, please include the following in pubspec.yaml

dependencies:
  djangoflow_openapi:
    path: /path/to/djangoflow_openapi

Getting Started #

Please follow the installation procedure and then run the following:

import 'package:djangoflow_openapi/djangoflow_openapi.dart';


final api = DjangoflowOpenapi().getV1Api();
final OTPObtainRequest oTPObtainRequest = ; // OTPObtainRequest | 

try {
    final response = await api.v1AuthOtpCreate(oTPObtainRequest);
    print(response);
} catch on DioError (e) {
    print("Exception when calling V1Api->v1AuthOtpCreate: $e\n");
}

Documentation for API Endpoints #

All URIs are relative to http://localhost

Class Method HTTP request Description
V1Api v1AuthOtpCreate POST /api/v1/auth/otp/
V1Api v1AuthOtpDevicesConfirmCreate POST /api/v1/auth/otp-devices/{id}/confirm/
V1Api v1AuthOtpDevicesCreate POST /api/v1/auth/otp-devices/
V1Api v1AuthOtpDevicesDestroy DELETE /api/v1/auth/otp-devices/{id}/
V1Api v1AuthOtpDevicesList GET /api/v1/auth/otp-devices/
V1Api v1AuthOtpDevicesRetrieve GET /api/v1/auth/otp-devices/{id}/
V1Api v1AuthSocialConnectCreate POST /api/v1/auth/social/connect/
V1Api v1AuthSocialCreate POST /api/v1/auth/social/
V1Api v1AuthTokenBlacklistCreate POST /api/v1/auth/token/blacklist/
V1Api v1AuthTokenCreate POST /api/v1/auth/token/
V1Api v1AuthTokenRefreshCreate POST /api/v1/auth/token/refresh/
V1Api v1AuthTokenVerifyCreate POST /api/v1/auth/token/verify/
V1Api v1AuthUsersCreate POST /api/v1/auth/users/
V1Api v1AuthUsersPartialUpdate PATCH /api/v1/auth/users/{id}/
V1Api v1AuthUsersRetrieve GET /api/v1/auth/users/{id}/
V1Api v1AuthUsersSetPasswordCreate POST /api/v1/auth/users/{id}/set-password/
V1Api v1AuthUsersTwoFaPartialUpdate PATCH /api/v1/auth/users/{id}/two-fa/
V1Api v1AuthUsersTwoFaRetrieve GET /api/v1/auth/users/{id}/two-fa/
V1Api v1NotificationsActionCategoriesList GET /api/v1/notifications/action-categories/
V1Api v1NotificationsDevicesCreate POST /api/v1/notifications/devices/
V1Api v1NotificationsDevicesDestroy DELETE /api/v1/notifications/devices/{registration_id}/
V1Api v1NotificationsDevicesList GET /api/v1/notifications/devices/
V1Api v1NotificationsDevicesPartialUpdate PATCH /api/v1/notifications/devices/{registration_id}/
V1Api v1NotificationsDevicesRetrieve GET /api/v1/notifications/devices/{registration_id}/
V1Api v1NotificationsDevicesUpdate PUT /api/v1/notifications/devices/{registration_id}/
V1Api v1RemoteconfigRetrieve GET /api/v1/remoteconfig/

Documentation For Models #

Documentation For Authorization #

Authentication schemes defined for the API:

jwtAuth #

  • Type: HTTP basic authentication

Author #