Skip to content

TeammatesApi.md

Latest commit

 

History

History
635 lines (473 loc) · 17.2 KB

TeammatesApi.md

File metadata and controls

635 lines (473 loc) · 17.2 KB

Flipdish.Api.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 (string appId, CreateTeammate teammate)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class CreateTeammateExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TeammatesApi();
            var appId = appId_example;  // string | 
            var teammate = new CreateTeammate(); // CreateTeammate | 

            try
            {
                RestApiResultTeammate result = apiInstance.CreateTeammate(appId, teammate);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TeammatesApi.CreateTeammate: " + e.Message );
            }
        }
    }
}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteTeammate

void DeleteTeammate (string appId, string id)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class DeleteTeammateExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TeammatesApi();
            var appId = appId_example;  // string | 
            var id = id_example;  // string | 

            try
            {
                apiInstance.DeleteTeammate(appId, id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TeammatesApi.DeleteTeammate: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
id string

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetTeammateByAppIdAndTeammateId

RestApiResultTeammate GetTeammateByAppIdAndTeammateId (string appId, string id)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GetTeammateByAppIdAndTeammateIdExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TeammatesApi();
            var appId = appId_example;  // string | 
            var id = id_example;  // string | 

            try
            {
                RestApiResultTeammate result = apiInstance.GetTeammateByAppIdAndTeammateId(appId, id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TeammatesApi.GetTeammateByAppIdAndTeammateId: " + e.Message );
            }
        }
    }
}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetTeammatesByAppId

RestApiArrayResultTeammate GetTeammatesByAppId (string appId)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GetTeammatesByAppIdExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TeammatesApi();
            var appId = appId_example;  // string | 

            try
            {
                RestApiArrayResultTeammate result = apiInstance.GetTeammatesByAppId(appId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TeammatesApi.GetTeammatesByAppId: " + e.Message );
            }
        }
    }
}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Grantaccess

Object Grantaccess (string appId, CreateTeammate teammate)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GrantaccessExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TeammatesApi();
            var appId = appId_example;  // string | 
            var teammate = new CreateTeammate(); // CreateTeammate | 

            try
            {
                Object result = apiInstance.Grantaccess(appId, teammate);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TeammatesApi.Grantaccess: " + e.Message );
            }
        }
    }
}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RedeemInvitation

RestApiResultRedeemInvitationResult RedeemInvitation (string otc, string appId)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class RedeemInvitationExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TeammatesApi();
            var otc = otc_example;  // string | 
            var appId = appId_example;  // string | 

            try
            {
                RestApiResultRedeemInvitationResult result = apiInstance.RedeemInvitation(otc, appId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TeammatesApi.RedeemInvitation: " + e.Message );
            }
        }
    }
}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

TeammatesAcceptInvitation

RestApiResultAcceptInvitationResult TeammatesAcceptInvitation (string otc, string appId)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class TeammatesAcceptInvitationExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TeammatesApi();
            var otc = otc_example;  // string | 
            var appId = appId_example;  // string | 

            try
            {
                RestApiResultAcceptInvitationResult result = apiInstance.TeammatesAcceptInvitation(otc, appId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TeammatesApi.TeammatesAcceptInvitation: " + e.Message );
            }
        }
    }
}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

TeammatesAcceptInvitations

RestApiArrayResultRedeemInvitationResult TeammatesAcceptInvitations ()

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class TeammatesAcceptInvitationsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TeammatesApi();

            try
            {
                RestApiArrayResultRedeemInvitationResult result = apiInstance.TeammatesAcceptInvitations();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TeammatesApi.TeammatesAcceptInvitations: " + e.Message );
            }
        }
    }
}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

TeammatesPendingInvitations

RestApiArrayResultPendingInvitation TeammatesPendingInvitations ()

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class TeammatesPendingInvitationsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TeammatesApi();

            try
            {
                RestApiArrayResultPendingInvitation result = apiInstance.TeammatesPendingInvitations();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TeammatesApi.TeammatesPendingInvitations: " + e.Message );
            }
        }
    }
}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateTeammate

RestApiResultTeammate UpdateTeammate (string appId, string id, TeammateBase teammate)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class UpdateTeammateExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TeammatesApi();
            var appId = appId_example;  // string | 
            var id = id_example;  // string | 
            var teammate = new TeammateBase(); // TeammateBase | 

            try
            {
                RestApiResultTeammate result = apiInstance.UpdateTeammate(appId, id, teammate);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TeammatesApi.UpdateTeammate: " + e.Message );
            }
        }
    }
}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]