Skip to content

Latest commit

 

History

History
647 lines (483 loc) · 18.6 KB

CampaignsApi.md

File metadata and controls

647 lines (483 loc) · 18.6 KB

Flipdish.Api.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 (string appId, LoyaltyCampaignBase campaign)

Example

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

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

            var apiInstance = new CampaignsApi();
            var appId = appId_example;  // string | 
            var campaign = new LoyaltyCampaignBase(); // LoyaltyCampaignBase | 

            try
            {
                RestApiResultLoyaltyCampaign result = apiInstance.CreateLoyaltyCampaign(appId, campaign);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CampaignsApi.CreateLoyaltyCampaign: " + e.Message );
            }
        }
    }
}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateRetentionCampaign

RestApiResultRetentionCampaign CreateRetentionCampaign (string appId, RetentionCampaignBase campaign)

Example

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

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

            var apiInstance = new CampaignsApi();
            var appId = appId_example;  // string | 
            var campaign = new RetentionCampaignBase(); // RetentionCampaignBase | 

            try
            {
                RestApiResultRetentionCampaign result = apiInstance.CreateRetentionCampaign(appId, campaign);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CampaignsApi.CreateRetentionCampaign: " + e.Message );
            }
        }
    }
}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetLoyaltyCampaignsForApp

RestApiArrayResultLoyaltyCampaign GetLoyaltyCampaignsForApp (string appId)

Example

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

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

            var apiInstance = new CampaignsApi();
            var appId = appId_example;  // string | 

            try
            {
                RestApiArrayResultLoyaltyCampaign result = apiInstance.GetLoyaltyCampaignsForApp(appId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CampaignsApi.GetLoyaltyCampaignsForApp: " + e.Message );
            }
        }
    }
}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetLoyaltyCampaignsForStore

RestApiArrayResultLoyaltyCampaign GetLoyaltyCampaignsForStore (string appId, int? storeId)

Example

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

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

            var apiInstance = new CampaignsApi();
            var appId = appId_example;  // string | 
            var storeId = 56;  // int? | 

            try
            {
                RestApiArrayResultLoyaltyCampaign result = apiInstance.GetLoyaltyCampaignsForStore(appId, storeId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CampaignsApi.GetLoyaltyCampaignsForStore: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
storeId int?

Return type

RestApiArrayResultLoyaltyCampaign

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]

GetRetentionCampaignsForApp

RestApiArrayResultRetentionCampaign GetRetentionCampaignsForApp (string appId)

Example

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

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

            var apiInstance = new CampaignsApi();
            var appId = appId_example;  // string | 

            try
            {
                RestApiArrayResultRetentionCampaign result = apiInstance.GetRetentionCampaignsForApp(appId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CampaignsApi.GetRetentionCampaignsForApp: " + e.Message );
            }
        }
    }
}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetRetentionCampaignsForStore

RestApiArrayResultRetentionCampaign GetRetentionCampaignsForStore (string appId, int? storeId)

Example

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

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

            var apiInstance = new CampaignsApi();
            var appId = appId_example;  // string | 
            var storeId = 56;  // int? | 

            try
            {
                RestApiArrayResultRetentionCampaign result = apiInstance.GetRetentionCampaignsForStore(appId, storeId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CampaignsApi.GetRetentionCampaignsForStore: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
storeId int?

Return type

RestApiArrayResultRetentionCampaign

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]

GetStoreList

RestApiArrayResultStoreListItem GetStoreList (string appId, bool? onlyPublished = null)

Example

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

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

            var apiInstance = new CampaignsApi();
            var appId = appId_example;  // string | 
            var onlyPublished = true;  // bool? |  (optional) 

            try
            {
                RestApiArrayResultStoreListItem result = apiInstance.GetStoreList(appId, onlyPublished);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CampaignsApi.GetStoreList: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
onlyPublished bool? [optional]

Return type

RestApiArrayResultStoreListItem

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]

RemoveCampaign

void RemoveCampaign (string appId, int? campaignId)

Example

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

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

            var apiInstance = new CampaignsApi();
            var appId = appId_example;  // string | 
            var campaignId = 56;  // int? | 

            try
            {
                apiInstance.RemoveCampaign(appId, campaignId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CampaignsApi.RemoveCampaign: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
campaignId int?

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]

UpdateLoyaltyCampaign

RestApiResultLoyaltyCampaign UpdateLoyaltyCampaign (string appId, int? campaignId, LoyaltyCampaignBase campaign)

Example

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

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

            var apiInstance = new CampaignsApi();
            var appId = appId_example;  // string | 
            var campaignId = 56;  // int? | 
            var campaign = new LoyaltyCampaignBase(); // LoyaltyCampaignBase | 

            try
            {
                RestApiResultLoyaltyCampaign result = apiInstance.UpdateLoyaltyCampaign(appId, campaignId, campaign);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CampaignsApi.UpdateLoyaltyCampaign: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
campaignId int?
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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateRetentionCampaign

RestApiResultRetentionCampaign UpdateRetentionCampaign (string appId, int? campaignId, RetentionCampaignBase campaign)

Example

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

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

            var apiInstance = new CampaignsApi();
            var appId = appId_example;  // string | 
            var campaignId = 56;  // int? | 
            var campaign = new RetentionCampaignBase(); // RetentionCampaignBase | 

            try
            {
                RestApiResultRetentionCampaign result = apiInstance.UpdateRetentionCampaign(appId, campaignId, campaign);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CampaignsApi.UpdateRetentionCampaign: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
campaignId int?
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

[Back to top] [Back to API list] [Back to Model list] [Back to README]