Skip to content

Latest commit

 

History

History
535 lines (383 loc) · 15.4 KB

TeammatesApi.md

File metadata and controls

535 lines (383 loc) · 15.4 KB

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}
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 classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.TeammatesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

TeammatesApi apiInstance = new TeammatesApi();
String appId = "appId_example"; // String | 
CreateTeammate teammate = new CreateTeammate(); // CreateTeammate | 
try {
    RestApiResultTeammate result = apiInstance.createTeammate(appId, teammate);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TeammatesApi#createTeammate");
    e.printStackTrace();
}

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

deleteTeammate

deleteTeammate(appId, id)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.TeammatesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

TeammatesApi apiInstance = new TeammatesApi();
String appId = "appId_example"; // String | 
String id = "id_example"; // String | 
try {
    apiInstance.deleteTeammate(appId, id);
} catch (ApiException e) {
    System.err.println("Exception when calling TeammatesApi#deleteTeammate");
    e.printStackTrace();
}

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 classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.TeammatesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

TeammatesApi apiInstance = new TeammatesApi();
String appId = "appId_example"; // String | 
String id = "id_example"; // String | 
try {
    RestApiResultTeammate result = apiInstance.getTeammateByAppIdAndTeammateId(appId, id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TeammatesApi#getTeammateByAppIdAndTeammateId");
    e.printStackTrace();
}

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

getTeammatesByAppId

RestApiArrayResultTeammate getTeammatesByAppId(appId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.TeammatesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

TeammatesApi apiInstance = new TeammatesApi();
String appId = "appId_example"; // String | 
try {
    RestApiArrayResultTeammate result = apiInstance.getTeammatesByAppId(appId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TeammatesApi#getTeammatesByAppId");
    e.printStackTrace();
}

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

grantaccess

Object grantaccess(appId, teammate)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.TeammatesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

TeammatesApi apiInstance = new TeammatesApi();
String appId = "appId_example"; // String | 
CreateTeammate teammate = new CreateTeammate(); // CreateTeammate | 
try {
    Object result = apiInstance.grantaccess(appId, teammate);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TeammatesApi#grantaccess");
    e.printStackTrace();
}

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

redeemInvitation

RestApiResultRedeemInvitationResult redeemInvitation(otc, appId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.TeammatesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

TeammatesApi apiInstance = new TeammatesApi();
String otc = "otc_example"; // String | 
String appId = "appId_example"; // String | 
try {
    RestApiResultRedeemInvitationResult result = apiInstance.redeemInvitation(otc, appId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TeammatesApi#redeemInvitation");
    e.printStackTrace();
}

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

teammatesAcceptInvitation

RestApiResultAcceptInvitationResult teammatesAcceptInvitation(otc, appId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.TeammatesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

TeammatesApi apiInstance = new TeammatesApi();
String otc = "otc_example"; // String | 
String appId = "appId_example"; // String | 
try {
    RestApiResultAcceptInvitationResult result = apiInstance.teammatesAcceptInvitation(otc, appId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TeammatesApi#teammatesAcceptInvitation");
    e.printStackTrace();
}

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

teammatesAcceptInvitations

RestApiArrayResultRedeemInvitationResult teammatesAcceptInvitations()

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.TeammatesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

TeammatesApi apiInstance = new TeammatesApi();
try {
    RestApiArrayResultRedeemInvitationResult result = apiInstance.teammatesAcceptInvitations();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TeammatesApi#teammatesAcceptInvitations");
    e.printStackTrace();
}

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

teammatesPendingInvitations

RestApiArrayResultPendingInvitation teammatesPendingInvitations()

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.TeammatesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

TeammatesApi apiInstance = new TeammatesApi();
try {
    RestApiArrayResultPendingInvitation result = apiInstance.teammatesPendingInvitations();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TeammatesApi#teammatesPendingInvitations");
    e.printStackTrace();
}

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

updateTeammate

RestApiResultTeammate updateTeammate(appId, id, teammate)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.TeammatesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

TeammatesApi apiInstance = new TeammatesApi();
String appId = "appId_example"; // String | 
String id = "id_example"; // String | 
TeammateBase teammate = new TeammateBase(); // TeammateBase | 
try {
    RestApiResultTeammate result = apiInstance.updateTeammate(appId, id, teammate);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TeammatesApi#updateTeammate");
    e.printStackTrace();
}

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