Skip to content

AccountsApi.md

Latest commit

 

History

History
1097 lines (809 loc) · 29.1 KB

AccountsApi.md

File metadata and controls

1097 lines (809 loc) · 29.1 KB

Flipdish.Api.AccountsApi

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

Method HTTP request Description
AnswerSignUpQuestion POST /api/v1.0/accounts/signupstep/{signupStepAction}/answer
ChangePassword PUT /api/v1.0/accounts/password
ChangePasswordWithPin PUT /api/v1.0/accounts/password/pin
CreateAccount POST /api/v1.0/accounts
CreateBasicAccount POST /api/v1.0/accounts/basic-account
GetAccountDetails GET /api/v1.0/accounts
GetLocalisedTimeZones GET /api/v1.0/accounts/timezones
Login POST /api/v1.0/accounts/login
LoginSso POST /api/v1.0/accounts/login/sso
LoginWithPin POST /api/v1.0/accounts/login/pin
Logout POST /api/v1.0/accounts/logout
PasswordResetWithToken POST /api/v1.0/accounts/password
RecaptchaValidate POST /api/v1.0/accounts/recaptcha
RequestLoginPin POST /api/v1.0/accounts/pin
RequestPasswordReset POST /api/v1.0/accounts/passwordreset
SendPinForPasswordReset POST /api/v1.0/accounts/password/resetpin
SkipSignupStep POST /api/v1.0/accounts/signupstep/{signupStepAction}/skip
UpdateAccount PUT /api/v1.0/accounts

AnswerSignUpQuestion

void AnswerSignUpQuestion (string signupStepAction, int? answerId)

Example

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

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

            var apiInstance = new AccountsApi();
            var signupStepAction = signupStepAction_example;  // string | 
            var answerId = 56;  // int? | 

            try
            {
                apiInstance.AnswerSignUpQuestion(signupStepAction, answerId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountsApi.AnswerSignUpQuestion: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
signupStepAction string
answerId int?

Return type

void (empty response body)

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]

ChangePassword

void ChangePassword (ChangePasswordModel changePasswordModel)

Example

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

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

            var apiInstance = new AccountsApi();
            var changePasswordModel = new ChangePasswordModel(); // ChangePasswordModel | 

            try
            {
                apiInstance.ChangePassword(changePasswordModel);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountsApi.ChangePassword: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
changePasswordModel ChangePasswordModel

Return type

void (empty response body)

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]

ChangePasswordWithPin

void ChangePasswordWithPin (SetPasswordWithPinModel changePasswordModel)

Example

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

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

            var apiInstance = new AccountsApi();
            var changePasswordModel = new SetPasswordWithPinModel(); // SetPasswordWithPinModel | 

            try
            {
                apiInstance.ChangePasswordWithPin(changePasswordModel);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountsApi.ChangePasswordWithPin: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
changePasswordModel SetPasswordWithPinModel

Return type

void (empty response body)

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]

CreateAccount

void CreateAccount (CreateAccountModel createAccountModel)

Example

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

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

            var apiInstance = new AccountsApi();
            var createAccountModel = new CreateAccountModel(); // CreateAccountModel | 

            try
            {
                apiInstance.CreateAccount(createAccountModel);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountsApi.CreateAccount: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
createAccountModel CreateAccountModel

Return type

void (empty response body)

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]

CreateBasicAccount

string CreateBasicAccount (CreateBasicAccountModel basicAccountModel)

Example

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

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

            var apiInstance = new AccountsApi();
            var basicAccountModel = new CreateBasicAccountModel(); // CreateBasicAccountModel | 

            try
            {
                string result = apiInstance.CreateBasicAccount(basicAccountModel);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountsApi.CreateBasicAccount: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
basicAccountModel CreateBasicAccountModel

Return type

string

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]

GetAccountDetails

RestApiResultAccountDetail GetAccountDetails ()

Example

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

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

            var apiInstance = new AccountsApi();

            try
            {
                RestApiResultAccountDetail result = apiInstance.GetAccountDetails();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountsApi.GetAccountDetails: " + e.Message );
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

RestApiResultAccountDetail

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]

GetLocalisedTimeZones

RestApiArrayResultLocalisedTimeZone GetLocalisedTimeZones ()

Example

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

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

            var apiInstance = new AccountsApi();

            try
            {
                RestApiArrayResultLocalisedTimeZone result = apiInstance.GetLocalisedTimeZones();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountsApi.GetLocalisedTimeZones: " + e.Message );
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

RestApiArrayResultLocalisedTimeZone

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]

Login

void Login (LoginModel loginModel)

Example

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

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

            var apiInstance = new AccountsApi();
            var loginModel = new LoginModel(); // LoginModel | 

            try
            {
                apiInstance.Login(loginModel);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountsApi.Login: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
loginModel LoginModel

Return type

void (empty response body)

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]

LoginSso

void LoginSso ()

Example

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

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

            var apiInstance = new AccountsApi();

            try
            {
                apiInstance.LoginSso();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountsApi.LoginSso: " + e.Message );
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

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]

LoginWithPin

void LoginWithPin (LoginWithPinModel loginModel)

Example

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

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

            var apiInstance = new AccountsApi();
            var loginModel = new LoginWithPinModel(); // LoginWithPinModel | 

            try
            {
                apiInstance.LoginWithPin(loginModel);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountsApi.LoginWithPin: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
loginModel LoginWithPinModel

Return type

void (empty response body)

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]

Logout

void Logout ()

Example

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

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

            var apiInstance = new AccountsApi();

            try
            {
                apiInstance.Logout();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountsApi.Logout: " + e.Message );
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

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]

PasswordResetWithToken

void PasswordResetWithToken (PasswordResetModel passwordResetModel)

Example

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

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

            var apiInstance = new AccountsApi();
            var passwordResetModel = new PasswordResetModel(); // PasswordResetModel | 

            try
            {
                apiInstance.PasswordResetWithToken(passwordResetModel);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountsApi.PasswordResetWithToken: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
passwordResetModel PasswordResetModel

Return type

void (empty response body)

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]

RecaptchaValidate

void RecaptchaValidate (string token)

Example

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

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

            var apiInstance = new AccountsApi();
            var token = token_example;  // string | 

            try
            {
                apiInstance.RecaptchaValidate(token);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountsApi.RecaptchaValidate: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
token 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]

RequestLoginPin

RequestLoginPinResponse RequestLoginPin (RequestLoginPinModel requestLoginPinRequest)

Example

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

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

            var apiInstance = new AccountsApi();
            var requestLoginPinRequest = new RequestLoginPinModel(); // RequestLoginPinModel | 

            try
            {
                RequestLoginPinResponse result = apiInstance.RequestLoginPin(requestLoginPinRequest);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountsApi.RequestLoginPin: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
requestLoginPinRequest RequestLoginPinModel

Return type

RequestLoginPinResponse

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]

RequestPasswordReset

void RequestPasswordReset (RequestPasswordResetModel requestPasswordResetModel)

Example

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

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

            var apiInstance = new AccountsApi();
            var requestPasswordResetModel = new RequestPasswordResetModel(); // RequestPasswordResetModel | 

            try
            {
                apiInstance.RequestPasswordReset(requestPasswordResetModel);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountsApi.RequestPasswordReset: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
requestPasswordResetModel RequestPasswordResetModel

Return type

void (empty response body)

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]

SendPinForPasswordReset

RequestPasswordResetPinResponse SendPinForPasswordReset (RequestPasswordResetModel requestPasswordResetRequest)

Example

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

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

            var apiInstance = new AccountsApi();
            var requestPasswordResetRequest = new RequestPasswordResetModel(); // RequestPasswordResetModel | 

            try
            {
                RequestPasswordResetPinResponse result = apiInstance.SendPinForPasswordReset(requestPasswordResetRequest);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountsApi.SendPinForPasswordReset: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
requestPasswordResetRequest RequestPasswordResetModel

Return type

RequestPasswordResetPinResponse

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]

SkipSignupStep

void SkipSignupStep (string signupStepAction)

Example

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

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

            var apiInstance = new AccountsApi();
            var signupStepAction = signupStepAction_example;  // string | 

            try
            {
                apiInstance.SkipSignupStep(signupStepAction);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountsApi.SkipSignupStep: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
signupStepAction 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]

UpdateAccount

void UpdateAccount (AccountDetailBase updateAccountModel)

Example

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

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

            var apiInstance = new AccountsApi();
            var updateAccountModel = new AccountDetailBase(); // AccountDetailBase | 

            try
            {
                apiInstance.UpdateAccount(updateAccountModel);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountsApi.UpdateAccount: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
updateAccountModel AccountDetailBase

Return type

void (empty response body)

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]