Skip to content

PushNotificationsApi.md

Latest commit

 

History

History
227 lines (159 loc) · 7.9 KB

PushNotificationsApi.md

File metadata and controls

227 lines (159 loc) · 7.9 KB

Flipdish\Client\PushNotificationsApi

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

Method HTTP request Description
deletePushNotification DELETE /api/v1.0/{appId}/pushnotifications/{scheduledPushNotificationId}
getPushNotifications GET /api/v1.0/{appId}/pushnotifications
schedulePushNotification POST /api/v1.0/{appId}/pushnotifications
updatePushNotification POST /api/v1.0/{appId}/pushnotifications/{scheduledPushNotificationId}

deletePushNotification

deletePushNotification($app_id, $scheduled_push_notification_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\PushNotificationsApi(
    // 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 | 
$scheduled_push_notification_id = 56; // int | 

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

Parameters

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

getPushNotifications

\Flipdish\Client\Models\RestApiPaginationResultPushNotificationResponse getPushNotifications($app_id, $page, $limit)

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\PushNotificationsApi(
    // 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 | 
$page = 56; // int | 
$limit = 56; // int | 

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

Parameters

Name Type Description Notes
app_id string
page int [optional]
limit int [optional]

Return type

\Flipdish\Client\Models\RestApiPaginationResultPushNotificationResponse

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]

schedulePushNotification

\Flipdish\Client\Models\RestApiResultPushNotificationResponse schedulePushNotification($app_id, $notification)

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\PushNotificationsApi(
    // 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 | 
$notification = new \Flipdish\\Client\Models\PushNotificationRequest(); // \Flipdish\\Client\Models\PushNotificationRequest | 

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

Parameters

Name Type Description Notes
app_id string
notification \Flipdish\Client\Models\PushNotificationRequest

Return type

\Flipdish\Client\Models\RestApiResultPushNotificationResponse

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]

updatePushNotification

\Flipdish\Client\Models\RestApiResultPushNotificationResponse updatePushNotification($app_id, $scheduled_push_notification_id, $notification)

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\PushNotificationsApi(
    // 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 | 
$scheduled_push_notification_id = 56; // int | 
$notification = new \Flipdish\\Client\Models\PushNotificationRequest(); // \Flipdish\\Client\Models\PushNotificationRequest | 

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

Parameters

Name Type Description Notes
app_id string
scheduled_push_notification_id int
notification \Flipdish\Client\Models\PushNotificationRequest

Return type

\Flipdish\Client\Models\RestApiResultPushNotificationResponse

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]