# RainbowAdminPortal.JoinCompanyInvitationsApi

All URIs are relative to *http://localhost*

Method | HTTP request | Description
------------- | ------------- | -------------
[**adminPostJoinCompanyInvite**](JoinCompanyInvitationsApi.md#adminPostJoinCompanyInvite) | **POST** /api/rainbow/admin/v1.0/companies/{companyId}/join-companies/invitations | Create a join company invitation
[**getJoinCompanyInvitations**](JoinCompanyInvitationsApi.md#getJoinCompanyInvitations) | **GET** /api/rainbow/admin/v1.0/companies/{companyId}/join-companies/invitations | Get all join company invitations
[**getJoinCompanyInviteById**](JoinCompanyInvitationsApi.md#getJoinCompanyInviteById) | **GET** /api/rainbow/admin/v1.0/companies/{companyId}/join-companies/invitations/{invitationId} | Get a join company invitation
[**putCancelJoinCompanyInviteById**](JoinCompanyInvitationsApi.md#putCancelJoinCompanyInviteById) | **POST** /api/rainbow/admin/v1.0/companies/{companyId}/join-companies/invitations/{invitationId}/cancel | Cancel a join company invitation
[**putFailedJoinCompanyInviteById**](JoinCompanyInvitationsApi.md#putFailedJoinCompanyInviteById) | **POST** /api/rainbow/admin/v1.0/companies/{companyId}/join-companies/invitations/{invitationId}/failed | Tag as failed a join company invitation
[**resendJoinCompanyInviteById**](JoinCompanyInvitationsApi.md#resendJoinCompanyInviteById) | **POST** /api/rainbow/admin/v1.0/companies/{companyId}/join-companies/invitations/{invitationId}/re-send | Re-send a join company invitation



## adminPostJoinCompanyInvite

> AdminPostJoinCompanyInviteSuccess adminPostJoinCompanyInvite(companyId, body)

Create a join company invitation

This API can be used by admin (`superadmin`, `bp_admin`, `bp_finance`, `organization_admin`, `company_admin`)    This API can be used by admin (`superadmin`, `bp_admin`, `bp_finance`, `organization_admin`, `company_admin`) users to create a join company invitation to a Rainbow user for a given company.       > `superadmin` can invite users to join all Rainbow companies    >    > `bp_admin` and `bp_finance` can only invite users to join their own company or End Customer companies for which their company is the BP company.    > `organization_admin` can only invite users to join companies being under their organisation.    > `company_admin` can only invite users to join their company.       ### Users can be invited:    #### by `email`    * by `email`:    * if no user is found with the provided email as loginEmail:      * an invitation to create his account in Rainbow and join the company is sent to the provided email address.     * User will be able to create his account using API [POST /api/rainbow/enduser/v1.0/users/self-register][0].     * InvitationId from the email link should be provided as joinCompanyInvitationId parameter of this API.    In that case, the join company invitation will be accepted and the user is created in the inviting company.     * If joinCompanyInvitationId is not provided, if the user registers with the same loginEmail than the join company invitation email, the join company invitation is auto-accepted and the user is created directly in the inviting company.     * If previous join company invitation has already been sent for another company to this email, the previous one is deleted and is replaced by a new join company invitation for the provided companyId.    In this case, admins of the other company are notified with the following XMPP message:         ```html <message type='management' id='122'         from='jid_from@openrainbow.com'         to='jid_to@openrainbow.com'         xmlns='jabber:client'>      <joincompanyinvite action=\"delete\" id='582048dfe2e68a79f4979624'       status='pending' type='sent' xmlns='jabber:iq:configuration'/> </message> ```   * if the loginEmail of a Rainbow user matches the provided email:      * user can only be invited if he is in the default company (otherwise an error is thrown)     * an invitation to join admin's company is sent by email and with an XMPP message:         ```html <message type='management' id='122'         from='jid_from@openrainbow.com'         to='jid_to@openrainbow.com'         xmlns='jabber:client'>      <joincompanyinvite action=\"create\" id='57cd5922d341df5812bbcb72'       status='pending' type='received' xmlns='jabber:iq:configuration'/> </message> ```           * It is possible for an existing Rainbow user to be invited by several admins of different companies.     * Invited user is able to list join company invitations he received using API [GET /api/rainbow/enduser/v1.0/users/:userId/join-companies/invitations][1]     * Invited user is able to accept a join company invitation using API [POST /api/rainbow/enduser/v1.0/users/:userId/join-companies/invitations/:invitationId/accept][2]     * Invited user is able to decline a join company invitation using API [POST /api/rainbow/enduser/v1.0/users/:userId/join-companies/invitations/:invitationId/decline][3] * by Rainbow user id (`invitedUserId`):    * if no user is found with the provided invitedUserId, an error 404 is returned   * otherwise, an invitation to join admin's company is sent by email and with an XMPP message.    Same documentation than existing user invited by email apply (see above).     For every use cases detailed above, all company administrators of the provided companyId are notified about the join company request creation with the following XMPP message:        ```html <message type='management' id='122'         from='jid_from@openrainbow.com'         to='jid_to@openrainbow.com'         xmlns='jabber:client'>      <joincompanyinvite action=\"create\" id='57cd5922d341df5812bbcb72'      status='pending' type='sent' xmlns='jabber:iq:configuration'/> </message> ```       Example: POST https://openrainbow.com/api/rainbow/admin/v1.0/companies/5703d0d49ccf39843c7ef897/join-companies/invitations  [0]: /enduser/#api-users-enduser_SelfRegisterUsers [1]: #api-join_company_invitations-enduser_GetJoinCompanyInvitations [2]: #api-join_company_invitations-enduser_PostAcceptJoinCompanyInvitation [3]: #api-join_company_invitations-enduser_PostDeclineJoinCompanyInvitation

### Example

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

var apiInstance = new RainbowAdminPortal.JoinCompanyInvitationsApi();
var companyId = "companyId_example"; // String | Company unique identifier (like 569ce8c8f9336c471b98eda1)
var body = new RainbowAdminPortal.AdminPostJoinCompanyInvite(); // AdminPostJoinCompanyInvite | 
apiInstance.adminPostJoinCompanyInvite(companyId, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters



Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **companyId** | **String**| Company unique identifier (like 569ce8c8f9336c471b98eda1) | 
 **body** | [**AdminPostJoinCompanyInvite**](AdminPostJoinCompanyInvite.md)|  | 

### Return type

[**AdminPostJoinCompanyInviteSuccess**](AdminPostJoinCompanyInviteSuccess.md)

### Authorization

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

### HTTP request headers

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


## getJoinCompanyInvitations

> GetJoinCompanyInvitationsSuccess getJoinCompanyInvitations(companyId, accept, opts)

Get all join company invitations

This API can be used by company `admin` users to list invitations he sent to Rainbow users so that they join his company.       Join company invitations allow users to join the related company using:   * API [POST /api/rainbow/enduser/v1.0/users/self-register][0] if invited email does not exist in Rainbow, * API [POST /api/rainbow/enduser/v1.0/users/:userId/join-companies/invitations/:invitationId/accept][1] if invited email matched an existing Rainbow user's loginEmail.     Example: GET https://openrainbow.com/api/rainbow/admin/v1.0/companies/5703d0d49ccf39843c7ef897/join-companies/invitations?status=pending    Example: GET https://openrainbow.com/api/rainbow/admin/v1.0/companies/5703d0d49ccf39843c7ef897/join-companies/invitations?status=accepted&status=auto-accepted  [0]: /enduser/#api-users-enduser_SelfRegisterUsers [1]: /enduser/#api-join_company_invitations-enduser_PostAcceptJoinCompanyInvitation

### Example

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

var apiInstance = new RainbowAdminPortal.JoinCompanyInvitationsApi();
var companyId = "companyId_example"; // String | Company unique identifier (like 569ce8c8f9336c471b98eda1)
var accept = "accept_example"; // String | application/json
var opts = {
  'status': "status_example", // String | List all join company invitations having the provided status(es)
  'format': "format_example", // String | Allows to retrieve more or less invitation details in response.    - `small`: id, companyId, invitedUserId, invitedUserLoginEmail, invitingAdminId, status    - `medium`: id, companyId, companyName, invitedUserId, invitedUserLoginEmail, invitingAdminId, invitingAdminLoginEmail, status, lastNotificationDate, invitingDate, acceptationDate, declinationDate    - `full`: all join company invitation fields
  'limit': 3.4, // Number | Allow to specify the number of invitations to retrieve.
  'offset': 3.4, // Number | Allow to specify the position of first invitation to retrieve (first invitation if not specified, i.e. offset=0). Warning: if offset > total, no results are returned.
  'sortField': "sortField_example", // String | Sort invitation list based on the given field.
  'sortOrder': 3.4 // Number | Specify order when sorting invitation list.
};
apiInstance.getJoinCompanyInvitations(companyId, accept, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters



Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **companyId** | **String**| Company unique identifier (like 569ce8c8f9336c471b98eda1) | 
 **accept** | **String**| application/json | 
 **status** | **String**| List all join company invitations having the provided status(es) | [optional] 
 **format** | **String**| Allows to retrieve more or less invitation details in response.    - `small`: id, companyId, invitedUserId, invitedUserLoginEmail, invitingAdminId, status    - `medium`: id, companyId, companyName, invitedUserId, invitedUserLoginEmail, invitingAdminId, invitingAdminLoginEmail, status, lastNotificationDate, invitingDate, acceptationDate, declinationDate    - `full`: all join company invitation fields | [optional] 
 **limit** | **Number**| Allow to specify the number of invitations to retrieve. | [optional] 
 **offset** | **Number**| Allow to specify the position of first invitation to retrieve (first invitation if not specified, i.e. offset=0). Warning: if offset > total, no results are returned. | [optional] 
 **sortField** | **String**| Sort invitation list based on the given field. | [optional] 
 **sortOrder** | **Number**| Specify order when sorting invitation list. | [optional] 

### Return type

[**GetJoinCompanyInvitationsSuccess**](GetJoinCompanyInvitationsSuccess.md)

### Authorization

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

### HTTP request headers

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


## getJoinCompanyInviteById

> GetJoinCompanyInviteByIdSuccess getJoinCompanyInviteById(companyId, invitationId, accept)

Get a join company invitation

This API can be used by company `admin` users to get a join company invitation he sent to a Rainbow user so that he join his company.       Join company invitations allow users to join the related company using:   * API [POST /api/rainbow/enduser/v1.0/users/self-register][0] if invited email does not exist in Rainbow, * API [POST /api/rainbow/enduser/v1.0/users/:userId/join-companies/invitations/:invitationId/accept][1] if invited email matched an existing Rainbow user's loginEmail.     Example: GET https://openrainbow.com/api/rainbow/admin/v1.0/companies/5703d0d49ccf39843c7ef897/join-companies/invitations/5819ed7c9547b313509237d6  [0]: /enduser/#api-users-enduser_SelfRegisterUsers [1]: /enduser/#api-join_company_invitations-enduser_PostAcceptJoinCompanyInvitation

### Example

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

var apiInstance = new RainbowAdminPortal.JoinCompanyInvitationsApi();
var companyId = "companyId_example"; // String | Company unique identifier (like 569ce8c8f9336c471b98eda1)
var invitationId = "invitationId_example"; // String | Join company invitation unique identifier (like 5819ed7c9547b313509237d6)
var accept = "accept_example"; // String | application/json
apiInstance.getJoinCompanyInviteById(companyId, invitationId, accept).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters



Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **companyId** | **String**| Company unique identifier (like 569ce8c8f9336c471b98eda1) | 
 **invitationId** | **String**| Join company invitation unique identifier (like 5819ed7c9547b313509237d6) | 
 **accept** | **String**| application/json | 

### Return type

[**GetJoinCompanyInviteByIdSuccess**](GetJoinCompanyInviteByIdSuccess.md)

### Authorization

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

### HTTP request headers

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


## putCancelJoinCompanyInviteById

> PutCancelJoinCompanyInviteByIdSuccess putCancelJoinCompanyInviteById(companyId, invitationId, body)

Cancel a join company invitation

This API can be used by company `admin` users to cancel a join company invitation already sent for his company to a given user / email.       Invitation must be pending, declined or failed (otherwise error 409 is returned).       Once invitation has been canceled, user won't be able to accept or decline it anymore.       All company admins are notified with an XMPP message that the invitation has been canceled:        ```html <message type='management' id='122'         from='jid_from@openrainbow.com'         to='jid_to@openrainbow.com'         xmlns='jabber:client'>      <joincompanyinvite action=\"update\" id='57cd5922d341df5812bbcb72'      status='canceled' type='sent' xmlns='jabber:iq:configuration'/> </message> ```       User (if he exist) is notified with an XMPP message that the invitation has been canceled:        ```html <message type='management' id='122'         from='jid_from@openrainbow.com'         to='jid_to@openrainbow.com'         xmlns='jabber:client'>      <joincompanyinvite action=\"update\" id='57cd5922d341df5812bbcb72'      status='canceled' type='received' xmlns='jabber:iq:configuration'/> </message> ```       Example: POST https://openrainbow.com/api/rainbow/admin/v1.0/companies/5703d0d49ccf39843c7ef897/join-companies/invitations/5819ed7c9547b313509237d6/cancel

### Example

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

var apiInstance = new RainbowAdminPortal.JoinCompanyInvitationsApi();
var companyId = "companyId_example"; // String | Company unique identifier (like 569ce8c8f9336c471b98eda1)
var invitationId = "invitationId_example"; // String | Join company invitation unique identifier (like 5819ed7c9547b313509237d6)
var body = new RainbowAdminPortal.PutCancelJoinCompanyInviteById(); // PutCancelJoinCompanyInviteById | 
apiInstance.putCancelJoinCompanyInviteById(companyId, invitationId, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters



Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **companyId** | **String**| Company unique identifier (like 569ce8c8f9336c471b98eda1) | 
 **invitationId** | **String**| Join company invitation unique identifier (like 5819ed7c9547b313509237d6) | 
 **body** | [**PutCancelJoinCompanyInviteById**](PutCancelJoinCompanyInviteById.md)|  | 

### Return type

[**PutCancelJoinCompanyInviteByIdSuccess**](PutCancelJoinCompanyInviteByIdSuccess.md)

### Authorization

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

### HTTP request headers

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


## putFailedJoinCompanyInviteById

> PutFailedJoinCompanyInviteByIdSuccess putFailedJoinCompanyInviteById(companyId, invitationId)

Tag as failed a join company invitation

This API can be used by a `superadmin` to tag an invitation sent by companies `admin` as 'failed'.    This API can only be used by a superadmin    Only invitations with the status 'pending' can be tagged.       Inviting admin is notified with an XMPP message that the invitation has been failed.    The XMPP message is the following:        ```html <message type='management' id='122'         from='jid_from@openrainbow.com'         to='jid_to@openrainbow.com'         xmlns='jabber:client'>      <joincompanyinvite id='57cd5922d341df5812bbcb72' action=\"update\"      type='sent' status='failed' xmlns='jabber:iq:configuration'/> </message> ```    

### Example

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

var apiInstance = new RainbowAdminPortal.JoinCompanyInvitationsApi();
var companyId = "companyId_example"; // String | Company unique identifier (like 569ce8c8f9336c471b98eda1)
var invitationId = "invitationId_example"; // String | Join company invitation unique identifier (like 5819ed7c9547b313509237d6)
apiInstance.putFailedJoinCompanyInviteById(companyId, invitationId).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters



Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **companyId** | **String**| Company unique identifier (like 569ce8c8f9336c471b98eda1) | 
 **invitationId** | **String**| Join company invitation unique identifier (like 5819ed7c9547b313509237d6) | 

### Return type

[**PutFailedJoinCompanyInviteByIdSuccess**](PutFailedJoinCompanyInviteByIdSuccess.md)

### Authorization

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

### HTTP request headers

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


## resendJoinCompanyInviteById

> ResendJoinCompanyInviteByIdSuccess resendJoinCompanyInviteById(companyId, invitationId, body)

Re-send a join company invitation

This API can be used by company `admin` users to re-send a join company invitation already sent for his company to a given user / email.       If invitation is canceled or declined or failed, it is set back to pending and then re-sent.    If invitation is accepted or auto-accepted, error 409 is returned.       Invited user receives a new email notification.    All company admins are notified with an XMPP message that the invitation has been re-sent:        ```html <message type='management' id='122'         from='jid_from@openrainbow.com'         to='jid_to@openrainbow.com'         xmlns='jabber:client'>      <joincompanyinvite action=\"re-send\" id='57cd5922d341df5812bbcb72'      status='pending' type='sent' xmlns='jabber:iq:configuration'/> </message> ```       User (if he exist) is notified with an XMPP message that the invitation has been re-sent:        ```html <message type='management' id='122'         from='jid_from@openrainbow.com'         to='jid_to@openrainbow.com'         xmlns='jabber:client'>      <joincompanyinvite action=\"re-send\" id='57cd5922d341df5812bbcb72'      status='pending' type='received' xmlns='jabber:iq:configuration'/> </message> ```       Example: POST https://openrainbow.com/api/rainbow/admin/v1.0/companies/5703d0d49ccf39843c7ef897/join-companies/invitations/5819ed7c9547b313509237d6/re-send

### Example

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

var apiInstance = new RainbowAdminPortal.JoinCompanyInvitationsApi();
var companyId = "companyId_example"; // String | Company unique identifier (like 569ce8c8f9336c471b98eda1)
var invitationId = "invitationId_example"; // String | Join company invitation unique identifier (like 5819ed7c9547b313509237d6)
var body = new RainbowAdminPortal.ResendJoinCompanyInviteById(); // ResendJoinCompanyInviteById | 
apiInstance.resendJoinCompanyInviteById(companyId, invitationId, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters



Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **companyId** | **String**| Company unique identifier (like 569ce8c8f9336c471b98eda1) | 
 **invitationId** | **String**| Join company invitation unique identifier (like 5819ed7c9547b313509237d6) | 
 **body** | [**ResendJoinCompanyInviteById**](ResendJoinCompanyInviteById.md)|  | 

### Return type

[**ResendJoinCompanyInviteByIdSuccess**](ResendJoinCompanyInviteByIdSuccess.md)

### Authorization

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

### HTTP request headers

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