Skip to content

CampaignsApi.md

Latest commit

 

History

History
510 lines (336 loc) · 13.8 KB

CampaignsApi.md

File metadata and controls

510 lines (336 loc) · 13.8 KB
Raw

Flipdish.CampaignsApi

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

Method HTTP request Description
createLoyaltyCampaign POST /api/v1.0/{appId}/campaigns/loyalty
createRetentionCampaign POST /api/v1.0/{appId}/campaigns/retention
getLoyaltyCampaignsForApp GET /api/v1.0/{appId}/campaigns/loyalty
getLoyaltyCampaignsForStore GET /api/v1.0/{appId}/campaigns/loyalty/{storeId}
getRetentionCampaignsForApp GET /api/v1.0/{appId}/campaigns/retention
getRetentionCampaignsForStore GET /api/v1.0/{appId}/campaigns/retention/{storeId}
getStoreList GET /api/v1.0/{appId}/campaigns/stores
removeCampaign DELETE /api/v1.0/{appId}/campaigns/{campaignId}
updateLoyaltyCampaign POST /api/v1.0/{appId}/campaigns/loyalty/{campaignId}
updateRetentionCampaign POST /api/v1.0/{appId}/campaigns/retention/{campaignId}

createLoyaltyCampaign

RestApiResultLoyaltyCampaign createLoyaltyCampaign(appId, campaign)

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.CampaignsApi();
let appId = "appId_example"; // String | 
let campaign = new Flipdish.LoyaltyCampaignBase(); // LoyaltyCampaignBase | 
apiInstance.createLoyaltyCampaign(appId, campaign, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String
campaign LoyaltyCampaignBase

Return type

RestApiResultLoyaltyCampaign

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

createRetentionCampaign

RestApiResultRetentionCampaign createRetentionCampaign(appId, campaign)

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.CampaignsApi();
let appId = "appId_example"; // String | 
let campaign = new Flipdish.RetentionCampaignBase(); // RetentionCampaignBase | 
apiInstance.createRetentionCampaign(appId, campaign, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String
campaign RetentionCampaignBase

Return type

RestApiResultRetentionCampaign

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

getLoyaltyCampaignsForApp

RestApiArrayResultLoyaltyCampaign getLoyaltyCampaignsForApp(appId)

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.CampaignsApi();
let appId = "appId_example"; // String | 
apiInstance.getLoyaltyCampaignsForApp(appId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String

Return type

RestApiArrayResultLoyaltyCampaign

Authorization

oauth2

HTTP request headers

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

getLoyaltyCampaignsForStore

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

Parameters

Name Type Description Notes
appId String
storeId Number

Return type

RestApiArrayResultLoyaltyCampaign

Authorization

oauth2

HTTP request headers

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

getRetentionCampaignsForApp

RestApiArrayResultRetentionCampaign getRetentionCampaignsForApp(appId)

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.CampaignsApi();
let appId = "appId_example"; // String | 
apiInstance.getRetentionCampaignsForApp(appId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String

Return type

RestApiArrayResultRetentionCampaign

Authorization

oauth2

HTTP request headers

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

getRetentionCampaignsForStore

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

Parameters

Name Type Description Notes
appId String
storeId Number

Return type

RestApiArrayResultRetentionCampaign

Authorization

oauth2

HTTP request headers

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

getStoreList

RestApiArrayResultStoreListItem getStoreList(appId, opts)

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.CampaignsApi();
let appId = "appId_example"; // String | 
let opts = {
  'onlyPublished': true // Boolean | 
};
apiInstance.getStoreList(appId, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String
onlyPublished Boolean [optional]

Return type

RestApiArrayResultStoreListItem

Authorization

oauth2

HTTP request headers

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

removeCampaign

removeCampaign(appId, campaignId)

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.CampaignsApi();
let appId = "appId_example"; // String | 
let campaignId = 56; // Number | 
apiInstance.removeCampaign(appId, campaignId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name Type Description Notes
appId String
campaignId 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, Message, ErrorCode, StackTrace

updateLoyaltyCampaign

RestApiResultLoyaltyCampaign updateLoyaltyCampaign(appId, campaignId, campaign)

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.CampaignsApi();
let appId = "appId_example"; // String | 
let campaignId = 56; // Number | 
let campaign = new Flipdish.LoyaltyCampaignBase(); // LoyaltyCampaignBase | 
apiInstance.updateLoyaltyCampaign(appId, campaignId, campaign, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String
campaignId Number
campaign LoyaltyCampaignBase

Return type

RestApiResultLoyaltyCampaign

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

updateRetentionCampaign

RestApiResultRetentionCampaign updateRetentionCampaign(appId, campaignId, campaign)

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.CampaignsApi();
let appId = "appId_example"; // String | 
let campaignId = 56; // Number | 
let campaign = new Flipdish.RetentionCampaignBase(); // RetentionCampaignBase | 
apiInstance.updateRetentionCampaign(appId, campaignId, campaign, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String
campaignId Number
campaign RetentionCampaignBase

Return type

RestApiResultRetentionCampaign

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