# EDropinAccounts.EaProfileInvitesApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**archiveProfileInvite**](EaProfileInvitesApi.md#archiveProfileInvite) | **DELETE** /profile-invites/{inviteId} | Archive a profile invitation
[**createProfileFromInvite**](EaProfileInvitesApi.md#createProfileFromInvite) | **POST** /profile-invites/referral/{referralCode} | Create a profile from a profile invite
[**createProfileInvite**](EaProfileInvitesApi.md#createProfileInvite) | **POST** /profile-invites | Create a new profile invite
[**getMultipleInvites**](EaProfileInvitesApi.md#getMultipleInvites) | **GET** /profile-invites/get-multi | Get Multiple Profile Invites
[**getProfileInviteReferral**](EaProfileInvitesApi.md#getProfileInviteReferral) | **GET** /profile-invites/referral/{referralCode} | Get the pre-filled fields for on-boarding an invite
[**listProfileInvites**](EaProfileInvitesApi.md#listProfileInvites) | **GET** /profile-invites | Paginate over all invitations made by requested user


<a name="archiveProfileInvite"></a>
# **archiveProfileInvite**
> EaSuccess archiveProfileInvite(inviteId)

Archive a profile invitation

### Example
```javascript
var EDropinAccounts = require('e_dropin_accounts');
var defaultClient = EDropinAccounts.ApiClient.instance;

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

// 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 = 'Token';

var apiInstance = new EDropinAccounts.EaProfileInvitesApi();

var inviteId = "inviteId_example"; // String | Profile Invitation Id


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.archiveProfileInvite(inviteId, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **inviteId** | **String**| Profile Invitation Id | 

### Return type

[**EaSuccess**](EaSuccess.md)

### Authorization

[Authorization](../README.md#Authorization), [ClientKey](../README.md#ClientKey)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="createProfileFromInvite"></a>
# **createProfileFromInvite**
> EaProfile createProfileFromInvite(referralCode, profileProps)

Create a profile from a profile invite

### Example
```javascript
var EDropinAccounts = require('e_dropin_accounts');
var defaultClient = EDropinAccounts.ApiClient.instance;

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

// 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 = 'Token';

var apiInstance = new EDropinAccounts.EaProfileInvitesApi();

var referralCode = "referralCode_example"; // String | Profile invitation referral code

var profileProps = new EDropinAccounts.EaProfileUpdate(); // EaProfileUpdate | Information to create profile


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.createProfileFromInvite(referralCode, profileProps, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **referralCode** | **String**| Profile invitation referral code | 
 **profileProps** | [**EaProfileUpdate**](EaProfileUpdate.md)| Information to create profile | 

### Return type

[**EaProfile**](EaProfile.md)

### Authorization

[Authorization](../README.md#Authorization), [ClientKey](../README.md#ClientKey)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="createProfileInvite"></a>
# **createProfileInvite**
> EaProfileInvite createProfileInvite(profileInviteProps)

Create a new profile invite

### Example
```javascript
var EDropinAccounts = require('e_dropin_accounts');
var defaultClient = EDropinAccounts.ApiClient.instance;

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

// 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 = 'Token';

var apiInstance = new EDropinAccounts.EaProfileInvitesApi();

var profileInviteProps = new EDropinAccounts.EaProfileInviteCreate(); // EaProfileInviteCreate | Profile to invite


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.createProfileInvite(profileInviteProps, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **profileInviteProps** | [**EaProfileInviteCreate**](EaProfileInviteCreate.md)| Profile to invite | 

### Return type

[**EaProfileInvite**](EaProfileInvite.md)

### Authorization

[Authorization](../README.md#Authorization), [ClientKey](../README.md#ClientKey)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="getMultipleInvites"></a>
# **getMultipleInvites**
> EaPagedProfileInvite getMultipleInvites(opts)

Get Multiple Profile Invites

### Example
```javascript
var EDropinAccounts = require('e_dropin_accounts');
var defaultClient = EDropinAccounts.ApiClient.instance;

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

// 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 = 'Token';

var apiInstance = new EDropinAccounts.EaProfileInvitesApi();

var opts = { 
  'inviteIds': ["inviteIds_example"] // [String] | 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getMultipleInvites(opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **inviteIds** | [**[String]**](String.md)|  | [optional] 

### Return type

[**EaPagedProfileInvite**](EaPagedProfileInvite.md)

### Authorization

[Authorization](../README.md#Authorization), [ClientKey](../README.md#ClientKey)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="getProfileInviteReferral"></a>
# **getProfileInviteReferral**
> EaProfileInvite getProfileInviteReferral(referralCode, )

Get the pre-filled fields for on-boarding an invite

### Example
```javascript
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 = 'Token';

var apiInstance = new EDropinAccounts.EaProfileInvitesApi();

var referralCode = "referralCode_example"; // String | Profile invitation referral code


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getProfileInviteReferral(referralCode, , callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **referralCode** | **String**| Profile invitation referral code | 

### Return type

[**EaProfileInvite**](EaProfileInvite.md)

### Authorization

[ClientKey](../README.md#ClientKey)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="listProfileInvites"></a>
# **listProfileInvites**
> EaProfileInvite listProfileInvites(opts)

Paginate over all invitations made by requested user

### Example
```javascript
var EDropinAccounts = require('e_dropin_accounts');
var defaultClient = EDropinAccounts.ApiClient.instance;

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

// 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 = 'Token';

var apiInstance = new EDropinAccounts.EaProfileInvitesApi();

var opts = { 
  'cursor': "cursor_example", // String | Start Cursor for query
  'limit': 20 // Number | Number of items returned
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.listProfileInvites(opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **cursor** | **String**| Start Cursor for query | [optional] 
 **limit** | **Number**| Number of items returned | [optional] [default to 20]

### Return type

[**EaProfileInvite**](EaProfileInvite.md)

### Authorization

[Authorization](../README.md#Authorization), [ClientKey](../README.md#ClientKey)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json