edropin_accountsapi 1.0.2 copy "edropin_accountsapi: ^1.0.2" to clipboard
edropin_accountsapi: ^1.0.2 copied to clipboard

OpenAPI API client

edropin_accountsapi #

Accounts service for eDropin

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

  • API version: 1.0.10
  • Build package: org.openapitools.codegen.languages.DartClientCodegen

Requirements #

Dart 1.20.0 or later OR Flutter 0.0.20 or later

Installation & Usage #

Github #

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

name: edropin_accountsapi
version: 1.0.0
description: OpenAPI API client
dependencies:
  edropin_accountsapi:
    git: https://github.com/GIT_USER_ID/GIT_REPO_ID.git
      version: 'any'

Local #

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

dependencies:
  edropin_accountsapi:
    path: /path/to/edropin_accountsapi

Tests #

TODO

Getting Started #

Please follow the installation procedure and then run the following:

import 'package:edropin_accountsapi/api.dart';

// TODO Configure API key authorization: ClientKey
//edropin_accountsapi.api.Configuration.apiKey{'X-Client-Key'} = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//edropin_accountsapi.api.Configuration.apiKeyPrefix{'X-Client-Key'} = "Bearer";

var api_instance = new EaAccountsApi();
var eaPasswordAuthentication = new EaPasswordAuthentication(); // EaPasswordAuthentication | Authentication values

try {
    var result = api_instance.authenticatePassword(eaPasswordAuthentication);
    print(result);
} catch (e) {
    print("Exception when calling EaAccountsApi->authenticatePassword: $e\n");
}

Documentation for API Endpoints #

All URIs are relative to https://edropin-test.appspot.com

Class Method HTTP request Description
EaAccountsApi authenticatePassword POST /accounts/authenticate/password Authenticate using email/password
EaAccountsApi getAccount GET /accounts Get Account
EaAccountsApi getMultipleAccounts GET /accounts/get-multi Get multiple accounts [service only]
EaAccountsApi updateAccount PUT /accounts Create/update existing account
EaAccountsApi updateAccountClaims PUT /accounts/{accountId}/claims Update account claims
EaPermissionsApi acceptPermissionInvite POST /permissions/accept-invite/{inviteToken} Accept a permission invite
EaPermissionsApi hasPermission GET /permissions/{entityType}/{entityId}/accounts/{accountId} Check account has permission
EaPermissionsApi paginatePermissions GET /permissions/{entityType}/{entityId}/accounts Get permissions for entity
EaPermissionsApi removePermissionsForAccount DELETE /permissions/{entityType}/{entityId}/accounts/{accountId} Remove all permissions for account
EaPermissionsApi sendPermissionInvite POST /permissions/{entityType}/{entityId}/send-invite Send a permission invite
EaPermissionsApi setPermission PUT /permissions/{entityType}/{entityId}/accounts/{accountId} Set account permission
EaProfileInvitesApi archiveProfileInvite DELETE /profile-invites/{inviteId} Archive a profile invitation
EaProfileInvitesApi createProfileFromInvite POST /profile-invites/referral/{referralCode} Create a profile from a profile invite
EaProfileInvitesApi createProfileInvite POST /profile-invites Create a new profile invite
EaProfileInvitesApi getMultipleInvites GET /profile-invites/get-multi Get Multiple Profile Invites
EaProfileInvitesApi getProfileInviteReferral GET /profile-invites/referral/{referralCode} Get the pre-filled fields for on-boarding an invite
EaProfileInvitesApi listProfileInvites GET /profile-invites Paginate over all invitations made by requested user
EaProfileTagsApi listTagRequests GET /profiles/{profileId}/profile-tags Paginate over all tag requests for the profile
EaProfileTagsApi removeProfileTagRequest DELETE /profile-tags/{profileTagId} Remove a profile tag request
EaProfileTagsApi respondToProfileTagRequest PUT /profile-tags/{profileTagId} Accept or decline a profile tag request
EaProfileTagsApi upsertProfileTagRequest POST /profiles/{profileId}/profile-tags Request to tag a profile in an entity e.g. Event, Course, etc.
EaProfilesApi checkAccountHasPermission GET /profiles/{profileId}/permissions/{accountId}/check Check account has permission
EaProfilesApi checkUsernameAvailability GET /profiles/usernamecheck Check username availability
EaProfilesApi createProfile POST /profiles Create profile
EaProfilesApi deleteProfile DELETE /profiles/{profileId} Delete an existing profile
EaProfilesApi getAccountPermissionForProfile GET /profiles/{profileId}/permissions/{accountId} Get permission for account
EaProfilesApi getAllProfiles GET /profiles Get Profiles
EaProfilesApi getMultipleProfiles GET /profiles/get-multi Get Multiple Profiles
EaProfilesApi getProfile GET /profiles/{profileId} Get a profile from the directory
EaProfilesApi getProfileCategories GET /profiles/categories Get Profile Categories
EaProfilesApi getProfilePermission GET /profiles/{profileId}/all-permissions List all profile permissions
EaProfilesApi paginateProfileFeed GET /profiles/{profileId}/feed Profile Feed
EaProfilesApi searchProfile GET /profiles/search Search Profiles
EaProfilesApi sendProfileEmailVerification POST /profiles/{profileId}/email-verification Send email verification
EaProfilesApi setProfilePermission PUT /profiles/{profileId}/permissions/{accountId} Set permission for profile
EaProfilesApi setStatus PUT /profiles/{profileId}/status Set a profile status
EaProfilesApi updateProfile PUT /profiles/{profileId} Update an existing profile
EaProfilesApi verifyProfileEmail POST /profiles/email-verification/{code} Verifiy profile email
EaUtilitiesApi checkPhoneVerification POST /utility/phoneverification/check Check phone verification
EaUtilitiesApi startPhoneVerification POST /utility/phoneverification/start Verify a phone number

Documentation For Models #

Documentation For Authorization #

AdminKey #

  • Type: API key
  • API key parameter name: X-Admin-Key
  • Location: HTTP header

Authorization #

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

AuthorizationOptional #

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

ClientKey #

  • Type: API key
  • API key parameter name: X-Client-Key
  • Location: HTTP header

ServiceKey #

  • Type: API key
  • API key parameter name: X-Service-Key
  • Location: HTTP header

Author #

dev@edropin.com

0
likes
5
pub points
0%
popularity

Publisher

unverified uploader

OpenAPI API client

Homepage

Dependencies

http

More

Packages that depend on edropin_accountsapi