Skip to content

Latest commit

 

History

History
547 lines (393 loc) · 16.6 KB

CampaignsApi.md

File metadata and controls

547 lines (393 loc) · 16.6 KB

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 classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.CampaignsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

CampaignsApi apiInstance = new CampaignsApi();
String appId = "appId_example"; // String | 
LoyaltyCampaignBase campaign = new LoyaltyCampaignBase(); // LoyaltyCampaignBase | 
try {
    RestApiResultLoyaltyCampaign result = apiInstance.createLoyaltyCampaign(appId, campaign);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CampaignsApi#createLoyaltyCampaign");
    e.printStackTrace();
}

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

createRetentionCampaign

RestApiResultRetentionCampaign createRetentionCampaign(appId, campaign)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.CampaignsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

CampaignsApi apiInstance = new CampaignsApi();
String appId = "appId_example"; // String | 
RetentionCampaignBase campaign = new RetentionCampaignBase(); // RetentionCampaignBase | 
try {
    RestApiResultRetentionCampaign result = apiInstance.createRetentionCampaign(appId, campaign);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CampaignsApi#createRetentionCampaign");
    e.printStackTrace();
}

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

getLoyaltyCampaignsForApp

RestApiArrayResultLoyaltyCampaign getLoyaltyCampaignsForApp(appId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.CampaignsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

CampaignsApi apiInstance = new CampaignsApi();
String appId = "appId_example"; // String | 
try {
    RestApiArrayResultLoyaltyCampaign result = apiInstance.getLoyaltyCampaignsForApp(appId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CampaignsApi#getLoyaltyCampaignsForApp");
    e.printStackTrace();
}

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

getLoyaltyCampaignsForStore

RestApiArrayResultLoyaltyCampaign getLoyaltyCampaignsForStore(appId, storeId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.CampaignsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

CampaignsApi apiInstance = new CampaignsApi();
String appId = "appId_example"; // String | 
Integer storeId = 56; // Integer | 
try {
    RestApiArrayResultLoyaltyCampaign result = apiInstance.getLoyaltyCampaignsForStore(appId, storeId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CampaignsApi#getLoyaltyCampaignsForStore");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
storeId Integer

Return type

RestApiArrayResultLoyaltyCampaign

Authorization

oauth2

HTTP request headers

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

getRetentionCampaignsForApp

RestApiArrayResultRetentionCampaign getRetentionCampaignsForApp(appId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.CampaignsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

CampaignsApi apiInstance = new CampaignsApi();
String appId = "appId_example"; // String | 
try {
    RestApiArrayResultRetentionCampaign result = apiInstance.getRetentionCampaignsForApp(appId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CampaignsApi#getRetentionCampaignsForApp");
    e.printStackTrace();
}

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

getRetentionCampaignsForStore

RestApiArrayResultRetentionCampaign getRetentionCampaignsForStore(appId, storeId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.CampaignsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

CampaignsApi apiInstance = new CampaignsApi();
String appId = "appId_example"; // String | 
Integer storeId = 56; // Integer | 
try {
    RestApiArrayResultRetentionCampaign result = apiInstance.getRetentionCampaignsForStore(appId, storeId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CampaignsApi#getRetentionCampaignsForStore");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
storeId Integer

Return type

RestApiArrayResultRetentionCampaign

Authorization

oauth2

HTTP request headers

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

getStoreList

RestApiArrayResultStoreListItem getStoreList(appId, onlyPublished)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.CampaignsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

CampaignsApi apiInstance = new CampaignsApi();
String appId = "appId_example"; // String | 
Boolean onlyPublished = true; // Boolean | 
try {
    RestApiArrayResultStoreListItem result = apiInstance.getStoreList(appId, onlyPublished);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CampaignsApi#getStoreList");
    e.printStackTrace();
}

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

removeCampaign

removeCampaign(appId, campaignId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.CampaignsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

CampaignsApi apiInstance = new CampaignsApi();
String appId = "appId_example"; // String | 
Integer campaignId = 56; // Integer | 
try {
    apiInstance.removeCampaign(appId, campaignId);
} catch (ApiException e) {
    System.err.println("Exception when calling CampaignsApi#removeCampaign");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
campaignId Integer

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

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

updateLoyaltyCampaign

RestApiResultLoyaltyCampaign updateLoyaltyCampaign(appId, campaignId, campaign)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.CampaignsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

CampaignsApi apiInstance = new CampaignsApi();
String appId = "appId_example"; // String | 
Integer campaignId = 56; // Integer | 
LoyaltyCampaignBase campaign = new LoyaltyCampaignBase(); // LoyaltyCampaignBase | 
try {
    RestApiResultLoyaltyCampaign result = apiInstance.updateLoyaltyCampaign(appId, campaignId, campaign);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CampaignsApi#updateLoyaltyCampaign");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
campaignId Integer
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

updateRetentionCampaign

RestApiResultRetentionCampaign updateRetentionCampaign(appId, campaignId, campaign)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.CampaignsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

CampaignsApi apiInstance = new CampaignsApi();
String appId = "appId_example"; // String | 
Integer campaignId = 56; // Integer | 
RetentionCampaignBase campaign = new RetentionCampaignBase(); // RetentionCampaignBase | 
try {
    RestApiResultRetentionCampaign result = apiInstance.updateRetentionCampaign(appId, campaignId, campaign);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CampaignsApi#updateRetentionCampaign");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
campaignId Integer
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