Flipdish\Client\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

\Flipdish\Client\Models\RestApiResultWebsiteTestimonial addTestimonial($app_id, $testimonial)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\WebsiteApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$app_id = "app_id_example"; // string | 
$testimonial = new \Flipdish\\Client\Models\WebsiteTestimonialBase(); // \Flipdish\\Client\Models\WebsiteTestimonialBase | 

try {
    $result = $apiInstance->addTestimonial($app_id, $testimonial);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebsiteApi->addTestimonial: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
app_id	string
testimonial	\Flipdish\Client\Models\WebsiteTestimonialBase

Return type

\Flipdish\Client\Models\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

deleteTestimonial($app_id, $testimonial_id)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\WebsiteApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$app_id = "app_id_example"; // string | 
$testimonial_id = 56; // int | 

try {
    $apiInstance->deleteTestimonial($app_id, $testimonial_id);
} catch (Exception $e) {
    echo 'Exception when calling WebsiteApi->deleteTestimonial: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
app_id	string
testimonial_id	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

deleteWebsiteImage($app_id, $image_id)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\WebsiteApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$app_id = "app_id_example"; // string | 
$image_id = 56; // int | 

try {
    $apiInstance->deleteWebsiteImage($app_id, $image_id);
} catch (Exception $e) {
    echo 'Exception when calling WebsiteApi->deleteWebsiteImage: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
app_id	string
image_id	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

\Flipdish\Client\Models\RestApiResultWebsiteTestimonial editTestimonial($app_id, $testimonial_id, $testimonial)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\WebsiteApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$app_id = "app_id_example"; // string | 
$testimonial_id = 56; // int | 
$testimonial = new \Flipdish\\Client\Models\WebsiteTestimonialBase(); // \Flipdish\\Client\Models\WebsiteTestimonialBase | 

try {
    $result = $apiInstance->editTestimonial($app_id, $testimonial_id, $testimonial);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebsiteApi->editTestimonial: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
app_id	string
testimonial_id	int
testimonial	\Flipdish\Client\Models\WebsiteTestimonialBase

Return type

\Flipdish\Client\Models\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

\Flipdish\Client\Models\RestApiResultIndexPage getIndexConfiguration($app_id)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\WebsiteApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$app_id = "app_id_example"; // string | 

try {
    $result = $apiInstance->getIndexConfiguration($app_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebsiteApi->getIndexConfiguration: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
app_id	string

Return type

\Flipdish\Client\Models\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

\Flipdish\Client\Models\RestApiResultIndexPageBase setIndexConfiguration($app_id, $index_page)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\WebsiteApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$app_id = "app_id_example"; // string | 
$index_page = new \Flipdish\\Client\Models\IndexPageBase(); // \Flipdish\\Client\Models\IndexPageBase | 

try {
    $result = $apiInstance->setIndexConfiguration($app_id, $index_page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebsiteApi->setIndexConfiguration: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
app_id	string
index_page	\Flipdish\Client\Models\IndexPageBase

Return type

\Flipdish\Client\Models\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

\Flipdish\Client\Models\RestApiResultWebsiteImage uploadWebsiteImage($app_id, $image_location, $image)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\WebsiteApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$app_id = "app_id_example"; // string | 
$image_location = "image_location_example"; // string | 
$image = "/path/to/file.txt"; // \SplFileObject | App Logo

try {
    $result = $apiInstance->uploadWebsiteImage($app_id, $image_location, $image);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebsiteApi->uploadWebsiteImage: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description
app_id	string
image_location	string
image	\SplFileObject	App Logo

Return type

\Flipdish\Client\Models\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

websiteCheckNow($app_id)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\WebsiteApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$app_id = "app_id_example"; // string | 

try {
    $apiInstance->websiteCheckNow($app_id);
} catch (Exception $e) {
    echo 'Exception when calling WebsiteApi->websiteCheckNow: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
app_id	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]

FilesExpand file tree

WebsiteApi.md

Latest commit

History

WebsiteApi.md

File metadata and controls

Flipdish\Client\WebsiteApi

addTestimonial

Example

Parameters

Return type

Authorization

HTTP request headers

deleteTestimonial

Example

Parameters

Return type

Authorization

HTTP request headers

deleteWebsiteImage

Example

Parameters

Return type

Authorization

HTTP request headers

editTestimonial

Example

Parameters

Return type

Authorization

HTTP request headers

getIndexConfiguration

Example

Parameters

Return type

Authorization

HTTP request headers

setIndexConfiguration

Example

Parameters

Return type

Authorization

HTTP request headers

uploadWebsiteImage

Example

Parameters

Return type

Authorization

HTTP request headers

websiteCheckNow

Example

Parameters

Return type

Authorization

HTTP request headers