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

ClassMethodHTTP requestDescription
EaAccountsApiauthenticatePasswordPOST /accounts/authenticate/passwordAuthenticate using email/password
EaAccountsApigetAccountGET /accountsGet Account
EaAccountsApigetMultipleAccountsGET /accounts/get-multiGet multiple accounts service only
EaAccountsApiupdateAccountPUT /accountsCreate/update existing account
EaAccountsApiupdateAccountClaimsPUT /accounts/{accountId}/claimsUpdate account claims
EaPermissionsApiacceptPermissionInvitePOST /permissions/accept-invite/{inviteToken}Accept a permission invite
EaPermissionsApihasPermissionGET /permissions/{entityType}/{entityId}/accounts/{accountId}Check account has permission
EaPermissionsApipaginatePermissionsGET /permissions/{entityType}/{entityId}/accountsGet permissions for entity
EaPermissionsApiremovePermissionsForAccountDELETE /permissions/{entityType}/{entityId}/accounts/{accountId}Remove all permissions for account
EaPermissionsApisendPermissionInvitePOST /permissions/{entityType}/{entityId}/send-inviteSend a permission invite
EaPermissionsApisetPermissionPUT /permissions/{entityType}/{entityId}/accounts/{accountId}Set account permission
EaProfileInvitesApiarchiveProfileInviteDELETE /profile-invites/{inviteId}Archive a profile invitation
EaProfileInvitesApicreateProfileFromInvitePOST /profile-invites/referral/{referralCode}Create a profile from a profile invite
EaProfileInvitesApicreateProfileInvitePOST /profile-invitesCreate a new profile invite
EaProfileInvitesApigetMultipleInvitesGET /profile-invites/get-multiGet Multiple Profile Invites
EaProfileInvitesApigetProfileInviteReferralGET /profile-invites/referral/{referralCode}Get the pre-filled fields for on-boarding an invite
EaProfileInvitesApilistProfileInvitesGET /profile-invitesPaginate over all invitations made by requested user
EaProfileTagsApilistTagRequestsGET /profiles/{profileId}/profile-tagsPaginate over all tag requests for the profile
EaProfileTagsApiremoveProfileTagRequestDELETE /profile-tags/{profileTagId}Remove a profile tag request
EaProfileTagsApirespondToProfileTagRequestPUT /profile-tags/{profileTagId}Accept or decline a profile tag request
EaProfileTagsApiupsertProfileTagRequestPOST /profiles/{profileId}/profile-tagsRequest to tag a profile in an entity e.g. Event, Course, etc.
EaProfilesApicheckAccountHasPermissionGET /profiles/{profileId}/permissions/{accountId}/checkCheck account has permission
EaProfilesApicheckUsernameAvailabilityGET /profiles/usernamecheckCheck username availability
EaProfilesApicreateProfilePOST /profilesCreate profile
EaProfilesApideleteProfileDELETE /profiles/{profileId}Delete an existing profile
EaProfilesApigetAccountPermissionForProfileGET /profiles/{profileId}/permissions/{accountId}Get permission for account
EaProfilesApigetAllProfilesGET /profilesGet Profiles
EaProfilesApigetMultipleProfilesGET /profiles/get-multiGet Multiple Profiles
EaProfilesApigetProfileGET /profiles/{profileId}Get a profile from the directory
EaProfilesApigetProfileCategoriesGET /profiles/categoriesGet Profile Categories
EaProfilesApigetProfilePermissionGET /profiles/{profileId}/all-permissionsList all profile permissions
EaProfilesApipaginateProfileFeedGET /profiles/{profileId}/feedProfile Feed
EaProfilesApisearchProfileGET /profiles/searchSearch Profiles
EaProfilesApisendProfileEmailVerificationPOST /profiles/{profileId}/email-verificationSend email verification
EaProfilesApisetProfilePermissionPUT /profiles/{profileId}/permissions/{accountId}Set permission for profile
EaProfilesApisetStatusPUT /profiles/{profileId}/statusSet a profile status
EaProfilesApiupdateProfilePUT /profiles/{profileId}Update an existing profile
EaProfilesApiverifyProfileEmailPOST /profiles/email-verification/{code}Verifiy profile email
EaUtilitiesApicheckPhoneVerificationPOST /utility/phoneverification/checkCheck phone verification
EaUtilitiesApistartPhoneVerificationPOST /utility/phoneverification/startVerify 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

Libraries

edropin_accountsapi.api