edropin_accountsapi 1.0.2

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

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  edropin_accountsapi: ^1.0.2

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter pub get

Alternatively, your editor might support pub get or flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:edropin_accountsapi/api.dart';
import 'package:edropin_accountsapi/api/ea_accounts_api.dart';
import 'package:edropin_accountsapi/api/ea_permissions_api.dart';
import 'package:edropin_accountsapi/api/ea_profile_invites_api.dart';
import 'package:edropin_accountsapi/api/ea_profile_tags_api.dart';
import 'package:edropin_accountsapi/api/ea_profiles_api.dart';
import 'package:edropin_accountsapi/api/ea_utilities_api.dart';
import 'package:edropin_accountsapi/api_client.dart';
import 'package:edropin_accountsapi/api_exception.dart';
import 'package:edropin_accountsapi/api_helper.dart';
import 'package:edropin_accountsapi/auth/api_key_auth.dart';
import 'package:edropin_accountsapi/auth/authentication.dart';
import 'package:edropin_accountsapi/auth/http_basic_auth.dart';
import 'package:edropin_accountsapi/auth/oauth.dart';
import 'package:edropin_accountsapi/model/default_error.dart';
import 'package:edropin_accountsapi/model/ea_account.dart';
import 'package:edropin_accountsapi/model/ea_account_update.dart';
import 'package:edropin_accountsapi/model/ea_address.dart';
import 'package:edropin_accountsapi/model/ea_authentication.dart';
import 'package:edropin_accountsapi/model/ea_base_id.dart';
import 'package:edropin_accountsapi/model/ea_claims.dart';
import 'package:edropin_accountsapi/model/ea_email_verification.dart';
import 'package:edropin_accountsapi/model/ea_facet_search.dart';
import 'package:edropin_accountsapi/model/ea_facet_search_facet_hits.dart';
import 'package:edropin_accountsapi/model/ea_feed_item.dart';
import 'package:edropin_accountsapi/model/ea_geoloc.dart';
import 'package:edropin_accountsapi/model/ea_paged_account.dart';
import 'package:edropin_accountsapi/model/ea_paged_feed_item.dart';
import 'package:edropin_accountsapi/model/ea_paged_permission.dart';
import 'package:edropin_accountsapi/model/ea_paged_permission_invite.dart';
import 'package:edropin_accountsapi/model/ea_paged_profile.dart';
import 'package:edropin_accountsapi/model/ea_paged_profile_invite.dart';
import 'package:edropin_accountsapi/model/ea_paged_tag_request.dart';
import 'package:edropin_accountsapi/model/ea_pagination.dart';
import 'package:edropin_accountsapi/model/ea_password_authentication.dart';
import 'package:edropin_accountsapi/model/ea_permission.dart';
import 'package:edropin_accountsapi/model/ea_permission_accept.dart';
import 'package:edropin_accountsapi/model/ea_permission_check.dart';
import 'package:edropin_accountsapi/model/ea_permission_input.dart';
import 'package:edropin_accountsapi/model/ea_permission_invite.dart';
import 'package:edropin_accountsapi/model/ea_permission_invite_create.dart';
import 'package:edropin_accountsapi/model/ea_phone_verification.dart';
import 'package:edropin_accountsapi/model/ea_phone_verification_check.dart';
import 'package:edropin_accountsapi/model/ea_phone_verification_input.dart';
import 'package:edropin_accountsapi/model/ea_profile.dart';
import 'package:edropin_accountsapi/model/ea_profile_base.dart';
import 'package:edropin_accountsapi/model/ea_profile_invite.dart';
import 'package:edropin_accountsapi/model/ea_profile_invite_create.dart';
import 'package:edropin_accountsapi/model/ea_profile_status.dart';
import 'package:edropin_accountsapi/model/ea_profile_update.dart';
import 'package:edropin_accountsapi/model/ea_success.dart';
import 'package:edropin_accountsapi/model/ea_tag_request.dart';
import 'package:edropin_accountsapi/model/ea_tag_request_create.dart';
import 'package:edropin_accountsapi/model/ea_tag_respond.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
0
Health:
Code health derived from static analysis. [more]
4
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
35
Overall:
Weighted score of the above. [more]
8
Learn more about scoring.

We analyzed this package on Dec 5, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.6.1
  • pana: 0.12.21

Platforms

Detected platforms: Flutter, web, other

No platform restriction found in libraries.

Health suggestions

Fix lib/api/ea_profiles_api.dart. (-35.67 points)

Analysis of lib/api/ea_profiles_api.dart reported 88 hints, including:

line 18 col 12: Unnecessary new keyword.

line 21 col 12: Unnecessary new keyword.

line 24 col 12: Unnecessary new keyword.

line 38 col 26: Use isNotEmpty instead of length

line 43 col 29: Unnecessary new keyword.

Fix lib/api/ea_permissions_api.dart. (-18.17 points)

Analysis of lib/api/ea_permissions_api.dart reported 40 hints, including:

line 18 col 12: Unnecessary new keyword.

line 34 col 26: Use isNotEmpty instead of length

line 39 col 29: Unnecessary new keyword.

line 41 col 9: DO use curly braces for all flow control structures.

line 56 col 13: Unnecessary new keyword.

Fix lib/api/ea_profile_invites_api.dart. (-13.53 points)

Analysis of lib/api/ea_profile_invites_api.dart reported 29 hints, including:

line 18 col 12: Unnecessary new keyword.

line 31 col 26: Use isNotEmpty instead of length

line 36 col 29: Unnecessary new keyword.

line 38 col 9: DO use curly braces for all flow control structures.

line 53 col 13: Unnecessary new keyword.

Fix additional 51 files with analysis or formatting issues. (-228.09 points)

Additional issues in the following files:

  • lib/model/ea_profile.dart (29 hints)
  • lib/api/ea_accounts_api.dart (24 hints)
  • lib/model/ea_profile_update.dart (23 hints)
  • lib/api/ea_profile_tags_api.dart (22 hints)
  • lib/model/ea_profile_base.dart (20 hints)
  • lib/model/ea_tag_request.dart (20 hints)
  • lib/model/ea_profile_invite.dart (18 hints)
  • lib/model/ea_permission_invite.dart (17 hints)
  • lib/model/ea_account.dart (15 hints)
  • lib/model/ea_permission.dart (15 hints)
  • lib/model/ea_address.dart (14 hints)
  • lib/model/ea_feed_item.dart (12 hints)
  • lib/model/ea_profile_invite_create.dart (12 hints)
  • lib/model/ea_paged_profile.dart (11 hints)
  • lib/model/ea_tag_request_create.dart (11 hints)
  • lib/api/ea_utilities_api.dart (10 hints)
  • lib/model/ea_account_update.dart (10 hints)
  • lib/model/ea_base_id.dart (9 hints)
  • lib/model/ea_permission_accept.dart (9 hints)
  • lib/model/ea_facet_search_facet_hits.dart (8 hints)
  • lib/model/ea_paged_profile_invite.dart (8 hints)
  • lib/model/ea_pagination.dart (8 hints)
  • lib/model/ea_permission_check.dart (8 hints)
  • lib/model/ea_phone_verification_check.dart (8 hints)
  • lib/model/default_error.dart (7 hints)
  • lib/model/ea_authentication.dart (7 hints)
  • lib/model/ea_email_verification.dart (7 hints)
  • lib/model/ea_facet_search.dart (7 hints)
  • lib/model/ea_geoloc.dart (7 hints)
  • lib/model/ea_paged_account.dart (7 hints)
  • lib/model/ea_paged_feed_item.dart (7 hints)
  • lib/model/ea_paged_permission.dart (7 hints)
  • lib/model/ea_paged_permission_invite.dart (7 hints)
  • lib/model/ea_paged_tag_request.dart (7 hints)
  • lib/model/ea_password_authentication.dart (7 hints)
  • lib/model/ea_permission_invite_create.dart (7 hints)
  • lib/model/ea_phone_verification_input.dart (7 hints)
  • lib/model/ea_profile_status.dart (7 hints)
  • lib/model/ea_success.dart (7 hints)
  • lib/model/ea_claims.dart (6 hints)
  • lib/model/ea_permission_input.dart (6 hints)
  • lib/model/ea_phone_verification.dart (6 hints)
  • lib/model/ea_tag_respond.dart (5 hints)
  • lib/api_client.dart (1 hint)
  • lib/api_helper.dart (1 hint)
  • lib/api.dart (Run dartfmt to format lib/api.dart.)
  • lib/api_exception.dart (Run dartfmt to format lib/api_exception.dart.)
  • lib/auth/api_key_auth.dart (Run dartfmt to format lib/auth/api_key_auth.dart.)
  • lib/auth/authentication.dart (Run dartfmt to format lib/auth/authentication.dart.)
  • lib/auth/http_basic_auth.dart (Run dartfmt to format lib/auth/http_basic_auth.dart.)
  • lib/auth/oauth.dart (Run dartfmt to format lib/auth/oauth.dart.)

Maintenance issues and suggestions

Provide a file named CHANGELOG.md. (-20 points)

Changelog entries help developers follow the progress of your package. See the example generated by stagehand.

Support latest dependencies. (-10 points)

The version constraint in pubspec.yaml does not support the latest published versions for 1 dependency (http).

The package description is too short. (-20 points)

Add more detail to the description field of pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.

Maintain an example. (-10 points)

Create a short demo in the example/ directory to show how to use this package.

Common filename patterns include main.dart, example.dart, and edropin_accountsapi.dart. Packages with multiple examples should provide example/README.md.

For more information see the pub package layout conventions.

Homepage URL is insecure. (-5 points)

Update the homepage field and use a secure (https) URL.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0 <3.0.0
http >=0.11.1 <0.12.0 0.11.3+17 0.12.0+2
Transitive dependencies
async 2.4.0
charcode 1.1.2
collection 1.14.12
http_parser 3.1.3
meta 1.1.8
path 1.6.4
source_span 1.5.5
string_scanner 1.0.5
term_glyph 1.1.0
typed_data 1.1.6