1.0.28 • Published 5 years ago

@edropin/accounts-svc v1.0.28

Weekly downloads
-
License
UNLICENSED
Repository
-
Last release
5 years ago

e_dropin_accounts

EDropinAccounts - JavaScript client for e_dropin_accounts 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 e_dropin_accounts 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/GIT_USER_ID/GIT_REPO_ID 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

ClassMethodHTTP requestDescription
EDropinAccounts.EaAccountsApiauthenticatePasswordPOST /accounts/authenticate/passwordAuthenticate using email/password
EDropinAccounts.EaAccountsApigetAccountGET /accountsGet Account
EDropinAccounts.EaAccountsApigetMultipleAccountsGET /accounts/get-multiGet multiple accounts service only
EDropinAccounts.EaAccountsApiupdateAccountPUT /accountsCreate/update existing account
EDropinAccounts.EaAccountsApiupdateAccountClaimsPUT /accounts/{accountId}/claimsUpdate account claims
EDropinAccounts.EaFilesApicreateFilePOST /filesCreate a file
EDropinAccounts.EaFilesApicreateImagePOST /files/imageCreate an image file
EDropinAccounts.EaFilesApicreateUnsplashImagePOST /files/unsplash-imageCreate an unsplash image file
EDropinAccounts.EaFilesApideleteFileDELETE /files/{fileId}Delete a file
EDropinAccounts.EaFilesApilistFilesGET /filesList of files
EDropinAccounts.EaFilesApiretrieveFileGET /files/{fileId}Retrieve a file
EDropinAccounts.EaPermissionsApiacceptPermissionInvitePOST /permissions/accept-invite/{inviteToken}Accept a permission invite
EDropinAccounts.EaPermissionsApihasPermissionGET /permissions/{entityType}/{entityId}/accounts/{accountId}Check account has permission
EDropinAccounts.EaPermissionsApipaginatePermissionsGET /permissions/{entityType}/{entityId}/accountsGet permissions for entity
EDropinAccounts.EaPermissionsApiremovePermissionsForAccountDELETE /permissions/{entityType}/{entityId}/accounts/{accountId}Remove all permissions for account
EDropinAccounts.EaPermissionsApisendPermissionInvitePOST /permissions/{entityType}/{entityId}/send-inviteSend a permission invite
EDropinAccounts.EaPermissionsApisetPermissionPUT /permissions/{entityType}/{entityId}/accounts/{accountId}Set account permission
EDropinAccounts.EaProfileInvitesApiarchiveProfileInviteDELETE /profile-invites/{inviteId}Archive a profile invitation
EDropinAccounts.EaProfileInvitesApicreateProfileFromInvitePOST /profile-invites/referral/{referralCode}Create a profile from a profile invite
EDropinAccounts.EaProfileInvitesApicreateProfileInvitePOST /profile-invitesCreate a new profile invite
EDropinAccounts.EaProfileInvitesApigetMultipleInvitesGET /profile-invites/get-multiGet Multiple Profile Invites
EDropinAccounts.EaProfileInvitesApigetProfileInviteReferralGET /profile-invites/referral/{referralCode}Get the pre-filled fields for on-boarding an invite
EDropinAccounts.EaProfileInvitesApilistProfileInvitesGET /profile-invitesPaginate over all invitations made by requested user
EDropinAccounts.EaProfileTagsApilistTagRequestsGET /profiles/{profileId}/profile-tagsPaginate over all tag requests for the profile
EDropinAccounts.EaProfileTagsApiremoveProfileTagRequestDELETE /profile-tags/{profileTagId}Remove a profile tag request
EDropinAccounts.EaProfileTagsApirespondToProfileTagRequestPUT /profile-tags/{profileTagId}Accept or decline a profile tag request
EDropinAccounts.EaProfileTagsApiupsertProfileTagRequestPOST /profiles/{profileId}/profile-tagsRequest to tag a profile in an entity e.g. Event, Course, etc.
EDropinAccounts.EaProfilesApicheckUsernameAvailabilityGET /profiles/usernamecheckCheck username availability
EDropinAccounts.EaProfilesApicreateProfilePOST /profilesCreate profile
EDropinAccounts.EaProfilesApideleteProfileDELETE /profiles/{profileId}Delete an existing profile
EDropinAccounts.EaProfilesApigetAllProfilesGET /profilesList all profiles
EDropinAccounts.EaProfilesApigetMultipleProfilesGET /profiles/get-multiGet Multiple Profiles
EDropinAccounts.EaProfilesApigetProfileGET /profiles/{profileId}Get a profile from the directory
EDropinAccounts.EaProfilesApigetProfileCategoriesGET /profiles/categoriesGet Profile Categories
EDropinAccounts.EaProfilesApipaginateProfileFeedGET /profiles/{profileId}/feedProfile Feed
EDropinAccounts.EaProfilesApisearchProfileGET /profiles/searchSearch Profiles
EDropinAccounts.EaProfilesApisendProfileEmailVerificationPOST /profiles/{profileId}/email-verificationSend email verification
EDropinAccounts.EaProfilesApisetStatusPUT /profiles/{profileId}/statusSet a profile status
EDropinAccounts.EaProfilesApiupdateProfilePUT /profiles/{profileId}Update an existing profile
EDropinAccounts.EaProfilesApiverifyProfileEmailPOST /profiles/email-verification/{code}Verifiy profile email
EDropinAccounts.EaUnsplashApidownloadPhotoPOST /unsplashDownload trigger
EDropinAccounts.EaUnsplashApisearchPhotosGET /unsplashSearch unsplash for images

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
1.0.28

5 years ago

1.0.27

5 years ago

1.0.26

5 years ago

1.0.25

5 years ago

1.0.24

6 years ago

1.0.23

6 years ago

1.0.22

6 years ago

1.0.21

6 years ago

1.0.20

6 years ago

1.0.19

6 years ago

1.0.18

6 years ago

1.0.17

6 years ago

1.0.16

6 years ago

1.0.15

6 years ago

1.0.14

6 years ago

1.0.13

6 years ago

1.0.12

6 years ago

1.0.11

6 years ago

1.0.10

6 years ago

1.0.9

6 years ago

1.0.8

6 years ago

1.0.7

6 years ago

1.0.6

6 years ago

1.0.5

6 years ago

1.0.4

6 years ago

1.0.3

6 years ago

1.0.2

6 years ago

1.0.1

6 years ago

1.0.0

6 years ago