FpmApi.md

Flipdish.FpmApi

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

Method	HTTP request	Description
createFpmForStore	POST /api/v1.0/{storeId}/fpm
deleteFpmForStore	DELETE /api/v1.0/{storeId}/fpm
editFpmForStore	POST /api/v1.0/{storeId}/fpm/edit
getFpmForStore	GET /api/v1.0/{storeId}/fpm

createFpmForStore

Object createFpmForStore(storeId, phoneNumber)

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.FpmApi();
let storeId = 56; // Number | 
let phoneNumber = "phoneNumber_example"; // String | 
apiInstance.createFpmForStore(storeId, phoneNumber, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
storeId	Number
phoneNumber	String

Return type

Object

Authorization

oauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, text/json, application/xml, text/xml, TelephonyConfigId, ApmEnabled, Type, ConsentEnabled, SendAppLinkSms, UseCustomAppLinkSmsMessage, UseCustomVoiceMessage, ResendApmMessageAfterDays

deleteFpmForStore

deleteFpmForStore(storeId)

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.FpmApi();
let storeId = 56; // Number | 
apiInstance.deleteFpmForStore(storeId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name	Type	Description	Notes
storeId	Number

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

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

editFpmForStore

editFpmForStore(storeId, telephonyConfig)

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.FpmApi();
let storeId = 56; // Number | 
let telephonyConfig = new Flipdish.TelephonyConfig(); // TelephonyConfig | 
apiInstance.editFpmForStore(storeId, telephonyConfig, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name	Type	Description	Notes
storeId	Number
telephonyConfig	TelephonyConfig

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

getFpmForStore

TelephonyConfig getFpmForStore(storeId)

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.FpmApi();
let storeId = 56; // Number | 
apiInstance.getFpmForStore(storeId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
storeId	Number

Return type

TelephonyConfig

Authorization

oauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, text/json, application/xml, text/xml, TelephonyConfigId, ApmEnabled, Type, ConsentEnabled, SendAppLinkSms, UseCustomAppLinkSmsMessage, UseCustomVoiceMessage, ResendApmMessageAfterDays