camsoltechnologies / api-dart-client

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

sajentclubAPI (EXPERIMENTAL)

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

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

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

Requirements

  • Dart 2.12.0 or later OR Flutter 1.26.0 or later
  • Dio 4.0.0+

Installation & Usage

pub.dev

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

dependencies:
  sajentclubAPI: 1.0.0

Github

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

dependencies:
  sajentclubAPI:
    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:
  sajentclubAPI:
    path: /path/to/sajentclubAPI

Getting Started

Please follow the installation procedure and then run the following:

import 'package:sajentclubAPI/sajentclubAPI.dart';


final api = SajentclubAPI().getUserApi();
final BodyUID bodyUID = ; // BodyUID | Adding new user as friend

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

Documentation for API Endpoints

All URIs are relative to https://us-central1-sajent-club.cloudfunctions.net/dev

Class Method HTTP request Description
UserApi acceptFriendRequest POST /acceptFriendRequest/ Accept friend request from other user
UserApi deleteUserAccount DELETE /deleteUserAccount/ Delete the full user account and its profile picture immediately (currently logged-in)
UserApi getFriends GET /getFriends/ Get all friends from user
UserApi getFriendsByUserId GET /getFriendsByUserId/ Get the friends data of other people
UserApi getProfileById GET /getProfileById/ Get the profile data of other people
UserApi revokeFriendRequest DELETE /revokeFriendRequest/ Revoke friend request to other user sent before
UserApi searchUser GET /searchUser/ Search user by username
UserApi sendFriendRequest POST /sendFriendRequest/ Send friend request to other user

Documentation For Models

Documentation For Authorization

IdToken

  • Type: HTTP basic authentication

Author

nkoa.christophe@camsol.tech | lennard@app-innovators.de

About


Languages

Language:Dart 100.0%