djangoflow_openapi 0.0.16

DjangoFlow OpenAPI API Client

djangoflow_openapi (EXPERIMENTAL)

DF Chat API (Django)

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

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

Requirements

• Dart 2.15.0+ or Flutter 2.8.0+
• Dio 5.0.0+ (https://pub.dev/packages/dio)
• JSON Serializable 6.1.5+ (https://pub.dev/packages/json_serializable)

Installation & Usage

pub.dev

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

dependencies:
  djangoflow_openapi: 0.0.16

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().getAuthApi();
final ChangeRequest changeRequest = ; // ChangeRequest | 

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

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
AuthApi	authChangeCreate	POST /api/v1/auth/change/
AuthApi	authConnectCreate	POST /api/v1/auth/connect/
AuthApi	authInviteCreate	POST /api/v1/auth/invite/
AuthApi	authOtpCreate	POST /api/v1/auth/otp/
AuthApi	authSetPasswordCreate	POST /api/v1/auth/set-password/
AuthApi	authSignupCreate	POST /api/v1/auth/signup/
AuthApi	authSocialConnectCreate	POST /api/v1/auth/social/connect/
AuthApi	authSocialCreate	POST /api/v1/auth/social/
AuthApi	authSocialOauth1ConnectCreate	POST /api/v1/auth/social/oauth1/connect/
AuthApi	authSocialOauth1Create	POST /api/v1/auth/social/oauth1/
AuthApi	authTokenBlacklistCreate	POST /api/v1/auth/token/blacklist/
AuthApi	authTokenCreate	POST /api/v1/auth/token/
AuthApi	authTokenRefreshCreate	POST /api/v1/auth/token/refresh/
AuthApi	authTokenVerifyCreate	POST /api/v1/auth/token/verify/
AuthApi	authUnlinkCreate	POST /api/v1/auth/unlink/
ChatApi	chatImagesCreate	POST /api/v1/chat/images/
ChatApi	chatImagesDestroy	DELETE /api/v1/chat/images/{id}/
ChatApi	chatImagesList	GET /api/v1/chat/images/
ChatApi	chatImagesPartialUpdate	PATCH /api/v1/chat/images/{id}/
ChatApi	chatImagesRetrieve	GET /api/v1/chat/images/{id}/
ChatApi	chatImagesUpdate	PUT /api/v1/chat/images/{id}/
ChatApi	chatRoomsCreate	POST /api/v1/chat/rooms/
ChatApi	chatRoomsDestroy	DELETE /api/v1/chat/rooms/{id}/
ChatApi	chatRoomsList	GET /api/v1/chat/rooms/
ChatApi	chatRoomsMessagesCreate	POST /api/v1/chat/rooms/{room_pk}/messages/
ChatApi	chatRoomsMessagesDestroy	DELETE /api/v1/chat/rooms/{room_pk}/messages/{id}/
ChatApi	chatRoomsMessagesList	GET /api/v1/chat/rooms/{room_pk}/messages/
ChatApi	chatRoomsMessagesPartialUpdate	PATCH /api/v1/chat/rooms/{room_pk}/messages/{id}/
ChatApi	chatRoomsMessagesRetrieve	GET /api/v1/chat/rooms/{room_pk}/messages/{id}/
ChatApi	chatRoomsMessagesSeenCreate	POST /api/v1/chat/rooms/{room_pk}/messages/seen/
ChatApi	chatRoomsMessagesUpdate	PUT /api/v1/chat/rooms/{room_pk}/messages/{id}/
ChatApi	chatRoomsMuteCreate	POST /api/v1/chat/rooms/{id}/mute/
ChatApi	chatRoomsPartialUpdate	PATCH /api/v1/chat/rooms/{id}/
ChatApi	chatRoomsRetrieve	GET /api/v1/chat/rooms/{id}/
ChatApi	chatRoomsUnmuteCreate	POST /api/v1/chat/rooms/{id}/unmute/
ChatApi	chatRoomsUpdate	PUT /api/v1/chat/rooms/{id}/
ChatApi	chatRoomsUsersCreate	POST /api/v1/chat/rooms/{room_pk}/users/
ChatApi	chatRoomsUsersDestroy	DELETE /api/v1/chat/rooms/{room_pk}/users/{id}/
ChatApi	chatRoomsUsersList	GET /api/v1/chat/rooms/{room_pk}/users/
ChatApi	chatRoomsUsersNamesList	GET /api/v1/chat/rooms/{room_pk}/users/names/
ChatApi	chatRoomsUsersPartialUpdate	PATCH /api/v1/chat/rooms/{room_pk}/users/{id}/
ChatApi	chatRoomsUsersRetrieve	GET /api/v1/chat/rooms/{room_pk}/users/{id}/
ChatApi	chatRoomsUsersUpdate	PUT /api/v1/chat/rooms/{room_pk}/users/{id}/
NotificationsApi	notificationsActionCategoriesList	GET /api/v1/notifications/action-categories/
NotificationsApi	notificationsDevicesCreate	POST /api/v1/notifications/devices/
NotificationsApi	notificationsDevicesDestroy	DELETE /api/v1/notifications/devices/{registration_id}/
NotificationsApi	notificationsDevicesList	GET /api/v1/notifications/devices/
NotificationsApi	notificationsDevicesPartialUpdate	PATCH /api/v1/notifications/devices/{registration_id}/
NotificationsApi	notificationsDevicesRetrieve	GET /api/v1/notifications/devices/{registration_id}/
NotificationsApi	notificationsDevicesUpdate	PUT /api/v1/notifications/devices/{registration_id}/

Documentation For Models

• Change
• ChangeRequest
• Connect
• ConnectRequest
• Error
• ErrorResponse
• Invite
• InviteRequest
• Message
• MessageImage
• MessageRequest
• MessageSeen
• MessageSeenRequest
• OTPObtainRequest
• PaginatedMessageImageList
• PaginatedMessageList
• PaginatedRoomList
• PaginatedUserDeviceList
• PatchedMessageRequest
• PatchedRoomRequest
• PatchedUserDeviceRequest
• PushAction
• PushActionCategory
• Room
• RoomRequest
• RoomUser
• SetPasswordRequest
• Signup
• SignupRequest
• SocialOAuth1TokenObtainRequest
• SocialTokenObtainProviderEnum
• SocialTokenObtainRequest
• Token
• TokenBlacklistRequest
• TokenObtainRequest
• TokenRefreshRequest
• TokenVerifyRequest
• TypeEnum
• Unlink
• UnlinkRequest
• UserDevice
• UserDeviceRequest
• UserName

Documentation For Authorization

Authentication schemes defined for the API:

jwtAuth

• Type: HTTP basic authentication

Author