Skip to content

TeammatesApi.md

Latest commit

 

History

History
544 lines (355 loc) · 13.5 KB

TeammatesApi.md

File metadata and controls

544 lines (355 loc) · 13.5 KB
Raw

Flipdish.TeammatesApi

All URIs are relative to https://api.flipdish.co

Method HTTP request Description
createTeammate POST /api/v1.0/{appId}/teammates
deleteTeammate DELETE /api/v1.0/{appId}/teammates/{id}
getTeammateByAppIdAndTeammateId GET /api/v1.0/{appId}/teammates/{id}
getTeammatesByAppId GET /api/v1.0/{appId}/teammates
grantaccess POST /api/v1.0/{appId}/teammates/grantaccess
redeemInvitation GET /api/v1.0/{appId}/teammates/redeem/{otc}
teammateMobileRedirect GET /api/v1.0/teammates/mobile-redirect
teammatesAcceptInvitation GET /api/v1.0/{appId}/teammates/accept/{otc}
teammatesAcceptInvitations POST /api/v1.0/teammates/acceptInvitations
teammatesPendingInvitations GET /api/v1.0/teammates/pending-invitations
updateTeammate POST /api/v1.0/{appId}/teammates/{id}

createTeammate

RestApiResultTeammate createTeammate(appId, teammate)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.TeammatesApi();
let appId = "appId_example"; // String | 
let teammate = new Flipdish.CreateTeammate(); // CreateTeammate | 
apiInstance.createTeammate(appId, teammate, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String
teammate CreateTeammate

Return type

RestApiResultTeammate

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml, Data

deleteTeammate

deleteTeammate(appId, id)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.TeammatesApi();
let appId = "appId_example"; // String | 
let id = "id_example"; // String | 
apiInstance.deleteTeammate(appId, id, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name Type Description Notes
appId String
id String

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

getTeammateByAppIdAndTeammateId

RestApiResultTeammate getTeammateByAppIdAndTeammateId(appId, id)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.TeammatesApi();
let appId = "appId_example"; // String | 
let id = "id_example"; // String | 
apiInstance.getTeammateByAppIdAndTeammateId(appId, id, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String
id String

Return type

RestApiResultTeammate

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml, Data

getTeammatesByAppId

RestApiArrayResultTeammate getTeammatesByAppId(appId)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.TeammatesApi();
let appId = "appId_example"; // String | 
apiInstance.getTeammatesByAppId(appId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String

Return type

RestApiArrayResultTeammate

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml, Data

grantaccess

Object grantaccess(appId, teammate)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.TeammatesApi();
let appId = "appId_example"; // String | 
let teammate = new Flipdish.CreateTeammate(); // CreateTeammate | 
apiInstance.grantaccess(appId, teammate, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String
teammate CreateTeammate

Return type

Object

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml, Data

redeemInvitation

RestApiResultRedeemInvitationResult redeemInvitation(otc, appId)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.TeammatesApi();
let otc = "otc_example"; // String | 
let appId = "appId_example"; // String | 
apiInstance.redeemInvitation(otc, appId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
otc String
appId String

Return type

RestApiResultRedeemInvitationResult

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml, Data

teammateMobileRedirect

Object teammateMobileRedirect(portalUrl)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.TeammatesApi();
let portalUrl = "portalUrl_example"; // String | 
apiInstance.teammateMobileRedirect(portalUrl, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
portalUrl String

Return type

Object

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

teammatesAcceptInvitation

RestApiResultAcceptInvitationResult teammatesAcceptInvitation(otc, appId)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.TeammatesApi();
let otc = "otc_example"; // String | 
let appId = "appId_example"; // String | 
apiInstance.teammatesAcceptInvitation(otc, appId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
otc String
appId String

Return type

RestApiResultAcceptInvitationResult

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml, Data

teammatesAcceptInvitations

RestApiArrayResultRedeemInvitationResult teammatesAcceptInvitations()

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.TeammatesApi();
apiInstance.teammatesAcceptInvitations((error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

This endpoint does not need any parameter.

Return type

RestApiArrayResultRedeemInvitationResult

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml, Data

teammatesPendingInvitations

RestApiArrayResultPendingInvitation teammatesPendingInvitations()

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.TeammatesApi();
apiInstance.teammatesPendingInvitations((error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

This endpoint does not need any parameter.

Return type

RestApiArrayResultPendingInvitation

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml, Data

updateTeammate

RestApiResultTeammate updateTeammate(appId, id, teammate)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.TeammatesApi();
let appId = "appId_example"; // String | 
let id = "id_example"; // String | 
let teammate = new Flipdish.TeammateBase(); // TeammateBase | 
apiInstance.updateTeammate(appId, id, teammate, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String
id String
teammate TeammateBase

Return type

RestApiResultTeammate

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml, Data