Skip to content

AccountsApi.md

Latest commit

 

History

History
666 lines (428 loc) · 16.3 KB

AccountsApi.md

File metadata and controls

666 lines (428 loc) · 16.3 KB
Raw

Flipdish.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
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
logout POST /api/v1.0/accounts/logout
passwordResetWithToken POST /api/v1.0/accounts/password
recaptchaValidate POST /api/v1.0/accounts/recaptcha
requestPasswordReset POST /api/v1.0/accounts/passwordreset
skipSignupStep POST /api/v1.0/accounts/signupstep/{signupStepAction}/skip
updateAccount PUT /api/v1.0/accounts

answerSignUpQuestion

answerSignUpQuestion(signupStepAction, answerId)

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.AccountsApi();
let signupStepAction = "signupStepAction_example"; // String | 
let answerId = 56; // Number | 
apiInstance.answerSignUpQuestion(signupStepAction, answerId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name Type Description Notes
signupStepAction String
answerId Number

Return type

null (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

changePassword

changePassword(changePasswordModel)

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.AccountsApi();
let changePasswordModel = new Flipdish.ChangePasswordModel(); // ChangePasswordModel | 
apiInstance.changePassword(changePasswordModel, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name Type Description Notes
changePasswordModel ChangePasswordModel

Return type

null (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, Message, ErrorCode, StackTrace

createAccount

createAccount(createAccountModel)

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.AccountsApi();
let createAccountModel = new Flipdish.CreateAccountModel(); // CreateAccountModel | 
apiInstance.createAccount(createAccountModel, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name Type Description Notes
createAccountModel CreateAccountModel

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

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

createBasicAccount

String createBasicAccount(basicAccountModel)

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.AccountsApi();
let basicAccountModel = new Flipdish.CreateBasicAccountModel(); // CreateBasicAccountModel | 
apiInstance.createBasicAccount(basicAccountModel, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

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, Message, ErrorCode, StackTrace

getAccountDetails

RestApiResultAccountDetail getAccountDetails()

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.AccountsApi();
apiInstance.getAccountDetails((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

RestApiResultAccountDetail

Authorization

oauth2

HTTP request headers

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

getLocalisedTimeZones

RestApiArrayResultLocalisedTimeZone getLocalisedTimeZones()

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.AccountsApi();
apiInstance.getLocalisedTimeZones((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

RestApiArrayResultLocalisedTimeZone

Authorization

oauth2

HTTP request headers

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

login

login(loginModel)

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.AccountsApi();
let loginModel = new Flipdish.LoginModel(); // LoginModel | 
apiInstance.login(loginModel, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name Type Description Notes
loginModel LoginModel

Return type

null (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, Message, ErrorCode, StackTrace

loginSso

loginSso()

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.AccountsApi();
apiInstance.loginSso((error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

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

logout

logout()

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.AccountsApi();
apiInstance.logout((error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

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

passwordResetWithToken

passwordResetWithToken(passwordResetModel)

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.AccountsApi();
let passwordResetModel = new Flipdish.PasswordResetModel(); // PasswordResetModel | 
apiInstance.passwordResetWithToken(passwordResetModel, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name Type Description Notes
passwordResetModel PasswordResetModel

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

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

recaptchaValidate

recaptchaValidate(token)

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.AccountsApi();
let token = "token_example"; // String | 
apiInstance.recaptchaValidate(token, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name Type Description Notes
token String

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

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

requestPasswordReset

requestPasswordReset(requestPasswordResetModel)

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.AccountsApi();
let requestPasswordResetModel = new Flipdish.RequestPasswordResetModel(); // RequestPasswordResetModel | 
apiInstance.requestPasswordReset(requestPasswordResetModel, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name Type Description Notes
requestPasswordResetModel RequestPasswordResetModel

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

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

skipSignupStep

skipSignupStep(signupStepAction)

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.AccountsApi();
let signupStepAction = "signupStepAction_example"; // String | 
apiInstance.skipSignupStep(signupStepAction, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

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

updateAccount

updateAccount(updateAccountModel)

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.AccountsApi();
let updateAccountModel = new Flipdish.AccountDetailBase(); // AccountDetailBase | 
apiInstance.updateAccount(updateAccountModel, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name Type Description Notes
updateAccountModel AccountDetailBase

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

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