@edropin/accounts-svc

Accounts_service_for_eDropin

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
@edropin/accounts-svc
1.0.283 years ago4 years agoMinified + gzip package size for @edropin/accounts-svc in KB

Readme

edropinaccounts
EDropinAccounts - JavaScript client for edropinaccounts Accounts service for eDropin This SDK is automatically generated by the Swagger Codegen project:
  • API version: 1.1.0
  • Package version: 1.1.0
  • Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install e_dropin_accounts --save
Local development
To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:
npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:
npm link

Finally, switch to the directory you want to use your edropinaccounts from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('e_dropin_accounts') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g.
https://github.com/GITUSERID/GITREPOID then install it via:
npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):
browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:
module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:
var EDropinAccounts = require('e_dropin_accounts');

var defaultClient = EDropinAccounts.ApiClient.instance;

// Configure API key authorization: ClientKey
var ClientKey = defaultClient.authentications['ClientKey'];
ClientKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ClientKey.apiKeyPrefix['X-Client-Key'] = "Token"

var api = new EDropinAccounts.EaAccountsApi()

var authProps = new EDropinAccounts.EaPasswordAuthentication(); // {EaPasswordAuthentication} Authentication values


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.authenticatePassword(authProps, callback);

Documentation for API Endpoints

All URIs are relative to https://edropin-test.appspot.com
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- EDropinAccounts.EaAccountsApi | authenticatePassword | POST /accounts/authenticate/password | Authenticate using email/password EDropinAccounts.EaAccountsApi | getAccount | GET /accounts | Get Account EDropinAccounts.EaAccountsApi | getMultipleAccounts | GET /accounts/get-multi | Get multiple accounts service only EDropinAccounts.EaAccountsApi | updateAccount | PUT /accounts | Create/update existing account EDropinAccounts.EaAccountsApi | updateAccountClaims | PUT /accounts/{accountId}/claims | Update account claims EDropinAccounts.EaFilesApi | createFile | POST /files | Create a file EDropinAccounts.EaFilesApi | createImage | POST /files/image | Create an image file EDropinAccounts.EaFilesApi | createUnsplashImage | POST /files/unsplash-image | Create an unsplash image file EDropinAccounts.EaFilesApi | deleteFile | DELETE /files/{fileId} | Delete a file EDropinAccounts.EaFilesApi | listFiles | GET /files | List of files EDropinAccounts.EaFilesApi | retrieveFile | GET /files/{fileId} | Retrieve a file EDropinAccounts.EaPermissionsApi | acceptPermissionInvite | POST /permissions/accept-invite/{inviteToken} | Accept a permission invite EDropinAccounts.EaPermissionsApi | hasPermission | GET /permissions/{entityType}/{entityId}/accounts/{accountId} | Check account has permission EDropinAccounts.EaPermissionsApi | paginatePermissions | GET /permissions/{entityType}/{entityId}/accounts | Get permissions for entity EDropinAccounts.EaPermissionsApi | removePermissionsForAccount | DELETE /permissions/{entityType}/{entityId}/accounts/{accountId} | Remove all permissions for account EDropinAccounts.EaPermissionsApi | sendPermissionInvite | POST /permissions/{entityType}/{entityId}/send-invite | Send a permission invite EDropinAccounts.EaPermissionsApi | setPermission | PUT /permissions/{entityType}/{entityId}/accounts/{accountId} | Set account permission EDropinAccounts.EaProfileInvitesApi | archiveProfileInvite | DELETE /profile-invites/{inviteId} | Archive a profile invitation EDropinAccounts.EaProfileInvitesApi | createProfileFromInvite | POST /profile-invites/referral/{referralCode} | Create a profile from a profile invite EDropinAccounts.EaProfileInvitesApi | createProfileInvite | POST /profile-invites | Create a new profile invite EDropinAccounts.EaProfileInvitesApi | getMultipleInvites | GET /profile-invites/get-multi | Get Multiple Profile Invites EDropinAccounts.EaProfileInvitesApi | getProfileInviteReferral | GET /profile-invites/referral/{referralCode} | Get the pre-filled fields for on-boarding an invite EDropinAccounts.EaProfileInvitesApi | listProfileInvites | GET /profile-invites | Paginate over all invitations made by requested user EDropinAccounts.EaProfileTagsApi | listTagRequests | GET /profiles/{profileId}/profile-tags | Paginate over all tag requests for the profile EDropinAccounts.EaProfileTagsApi | removeProfileTagRequest | DELETE /profile-tags/{profileTagId} | Remove a profile tag request EDropinAccounts.EaProfileTagsApi | respondToProfileTagRequest | PUT /profile-tags/{profileTagId} | Accept or decline a profile tag request EDropinAccounts.EaProfileTagsApi | upsertProfileTagRequest | POST /profiles/{profileId}/profile-tags | Request to tag a profile in an entity e.g. Event, Course, etc. EDropinAccounts.EaProfilesApi | checkUsernameAvailability | GET /profiles/usernamecheck | Check username availability EDropinAccounts.EaProfilesApi | createProfile | POST /profiles | Create profile EDropinAccounts.EaProfilesApi | deleteProfile | DELETE /profiles/{profileId} | Delete an existing profile EDropinAccounts.EaProfilesApi | getAllProfiles | GET /profiles | List all profiles EDropinAccounts.EaProfilesApi | getMultipleProfiles | GET /profiles/get-multi | Get Multiple Profiles EDropinAccounts.EaProfilesApi | getProfile | GET /profiles/{profileId} | Get a profile from the directory EDropinAccounts.EaProfilesApi | getProfileCategories | GET /profiles/categories | Get Profile Categories EDropinAccounts.EaProfilesApi | paginateProfileFeed | GET /profiles/{profileId}/feed | Profile Feed EDropinAccounts.EaProfilesApi | searchProfile | GET /profiles/search | Search Profiles EDropinAccounts.EaProfilesApi | sendProfileEmailVerification | POST /profiles/{profileId}/email-verification | Send email verification EDropinAccounts.EaProfilesApi | setStatus | PUT /profiles/{profileId}/status | Set a profile status EDropinAccounts.EaProfilesApi | updateProfile | PUT /profiles/{profileId} | Update an existing profile EDropinAccounts.EaProfilesApi | verifyProfileEmail | POST /profiles/email-verification/{code} | Verifiy profile email EDropinAccounts.EaUnsplashApi | downloadPhoto | POST /unsplash | Download trigger EDropinAccounts.EaUnsplashApi | searchPhotos | GET /unsplash | Search unsplash for images

Documentation for Models

- EDropinAccounts.DefaultError - EDropinAccounts.EaAccountUpdate - EDropinAccounts.EaAuthentication - EDropinAccounts.EaBaseId - EDropinAccounts.EaClaims - EDropinAccounts.EaDSPagination - EDropinAccounts.EaEmailVerification - EDropinAccounts.EaFacetSearch - EDropinAccounts.EaFacetSearchFacetHits - EDropinAccounts.EaFeedItem - EDropinAccounts.EaFileUpdate - EDropinAccounts.EaImage - EDropinAccounts.EaPagedAccount - EDropinAccounts.EaPagedFeedItem - EDropinAccounts.EaPagedFile - EDropinAccounts.EaPagedPermission - EDropinAccounts.EaPagedPermissionInvite - EDropinAccounts.EaPagedProfile - EDropinAccounts.EaPagedProfileInvite - EDropinAccounts.EaPagedTagRequest - EDropinAccounts.EaPagedUnsplashPhoto - EDropinAccounts.EaPagination - EDropinAccounts.EaPasswordAuthentication - EDropinAccounts.EaPermission - EDropinAccounts.EaPermissionAccept - EDropinAccounts.EaPermissionCheck - EDropinAccounts.EaPermissionInput - EDropinAccounts.EaPermissionInvite - EDropinAccounts.EaPermissionInviteCreate - EDropinAccounts.EaProfileInviteCreate - EDropinAccounts.EaProfileStatus - EDropinAccounts.EaProfileUpdate - EDropinAccounts.EaSuccess - EDropinAccounts.EaTagRequestCreate - EDropinAccounts.EaTagRespond - EDropinAccounts.EaUnsplashPhoto - EDropinAccounts.EaAccount - EDropinAccounts.EaFile - EDropinAccounts.EaFileUpload - EDropinAccounts.EaProfile - EDropinAccounts.EaProfileCreate - EDropinAccounts.EaProfileInvite - EDropinAccounts.EaTagRequest

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