Skip to content

WebsiteApi.md

Latest commit

 

History

History
517 lines (385 loc) · 14.2 KB

WebsiteApi.md

File metadata and controls

517 lines (385 loc) · 14.2 KB

Flipdish.Api.WebsiteApi

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

Method HTTP request Description
AddTestimonial POST /api/v1.0/{appId}/website/testimonial
DeleteTestimonial DELETE /api/v1.0/{appId}/website/testimonial/{testimonialId}
DeleteWebsiteImage DELETE /api/v1.0/{appId}/website/image/{imageId}
EditTestimonial POST /api/v1.0/{appId}/website/testimonial/{testimonialId}
GetIndexConfiguration GET /api/v1.0/{appId}/website/index
SetIndexConfiguration POST /api/v1.0/{appId}/website/index
UploadWebsiteImage POST /api/v1.0/{appId}/website/image/{imageLocation}
WebsiteCheckNow GET /api/v1.0/{appId}/website/dnscheck

AddTestimonial

RestApiResultWebsiteTestimonial AddTestimonial (string appId, WebsiteTestimonialBase testimonial)

Example

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

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

            var apiInstance = new WebsiteApi();
            var appId = appId_example;  // string | 
            var testimonial = new WebsiteTestimonialBase(); // WebsiteTestimonialBase | 

            try
            {
                RestApiResultWebsiteTestimonial result = apiInstance.AddTestimonial(appId, testimonial);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebsiteApi.AddTestimonial: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
testimonial WebsiteTestimonialBase

Return type

RestApiResultWebsiteTestimonial

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]

DeleteTestimonial

void DeleteTestimonial (string appId, int? testimonialId)

Example

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

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

            var apiInstance = new WebsiteApi();
            var appId = appId_example;  // string | 
            var testimonialId = 56;  // int? | 

            try
            {
                apiInstance.DeleteTestimonial(appId, testimonialId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebsiteApi.DeleteTestimonial: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
testimonialId 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]

DeleteWebsiteImage

void DeleteWebsiteImage (string appId, int? imageId)

Example

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

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

            var apiInstance = new WebsiteApi();
            var appId = appId_example;  // string | 
            var imageId = 56;  // int? | 

            try
            {
                apiInstance.DeleteWebsiteImage(appId, imageId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebsiteApi.DeleteWebsiteImage: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
imageId 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]

EditTestimonial

RestApiResultWebsiteTestimonial EditTestimonial (string appId, int? testimonialId, WebsiteTestimonialBase testimonial)

Example

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

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

            var apiInstance = new WebsiteApi();
            var appId = appId_example;  // string | 
            var testimonialId = 56;  // int? | 
            var testimonial = new WebsiteTestimonialBase(); // WebsiteTestimonialBase | 

            try
            {
                RestApiResultWebsiteTestimonial result = apiInstance.EditTestimonial(appId, testimonialId, testimonial);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebsiteApi.EditTestimonial: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
testimonialId int?
testimonial WebsiteTestimonialBase

Return type

RestApiResultWebsiteTestimonial

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]

GetIndexConfiguration

RestApiResultIndexPage GetIndexConfiguration (string appId)

Example

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

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

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

            try
            {
                RestApiResultIndexPage result = apiInstance.GetIndexConfiguration(appId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebsiteApi.GetIndexConfiguration: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string

Return type

RestApiResultIndexPage

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]

SetIndexConfiguration

RestApiResultIndexPageBase SetIndexConfiguration (string appId, IndexPageBase indexPage)

Example

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

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

            var apiInstance = new WebsiteApi();
            var appId = appId_example;  // string | 
            var indexPage = new IndexPageBase(); // IndexPageBase | 

            try
            {
                RestApiResultIndexPageBase result = apiInstance.SetIndexConfiguration(appId, indexPage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebsiteApi.SetIndexConfiguration: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
indexPage IndexPageBase

Return type

RestApiResultIndexPageBase

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]

UploadWebsiteImage

RestApiResultWebsiteImage UploadWebsiteImage (string appId, string imageLocation, System.IO.Stream image)

Example

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

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

            var apiInstance = new WebsiteApi();
            var appId = appId_example;  // string | 
            var imageLocation = imageLocation_example;  // string | 
            var image = new System.IO.Stream(); // System.IO.Stream | App Logo

            try
            {
                RestApiResultWebsiteImage result = apiInstance.UploadWebsiteImage(appId, imageLocation, image);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebsiteApi.UploadWebsiteImage: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
imageLocation string
image System.IO.Stream App Logo

Return type

RestApiResultWebsiteImage

Authorization

oauth2

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json, text/json, application/xml, text/xml

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

WebsiteCheckNow

void WebsiteCheckNow (string appId)

Example

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

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

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

            try
            {
                apiInstance.WebsiteCheckNow(appId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebsiteApi.WebsiteCheckNow: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string

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]