Skip to content

Latest commit

 

History

History
338 lines (232 loc) · 9.69 KB

InAppNotificationApi.md

File metadata and controls

338 lines (232 loc) · 9.69 KB
Raw

Ringba\InAppNotificationApi

All URIs are relative to https://api.ringba.com

Method HTTP request Description
inAppNotificationDeleteMessage DELETE /notifications/{id}
inAppNotificationGetAll GET /notifications/all
inAppNotificationGetCounts GET /notifications/counts
inAppNotificationGetMessage GET /notifications/{id}
inAppNotificationGetMessages GET /notifications
inAppNotificationGetPreviews GET /notifications/toasts
inAppNotificationMarkMessageRead PUT /notifications/{id}

inAppNotificationDeleteMessage

object inAppNotificationDeleteMessage($id)

Example

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

$apiInstance = new Ringba\Api\InAppNotificationApi(
    // 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()
);
$id = "id_example"; // string | 

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

Parameters

Name Type Description Notes
id string

Return type

object

Authorization

No authorization required

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]

inAppNotificationGetAll

\Ringba\Model\GetAllResponse inAppNotificationGetAll()

Example

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

$apiInstance = new Ringba\Api\InAppNotificationApi(
    // 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()
);

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

Parameters

This endpoint does not need any parameter.

Return type

\Ringba\Model\GetAllResponse

Authorization

No authorization required

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]

inAppNotificationGetCounts

\Ringba\Model\CountResponse inAppNotificationGetCounts()

Example

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

$apiInstance = new Ringba\Api\InAppNotificationApi(
    // 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()
);

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

Parameters

This endpoint does not need any parameter.

Return type

\Ringba\Model\CountResponse

Authorization

No authorization required

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]

inAppNotificationGetMessage

\Ringba\Model\MessageResponse inAppNotificationGetMessage($id, $mark_as_read)

Example

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

$apiInstance = new Ringba\Api\InAppNotificationApi(
    // 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()
);
$id = "id_example"; // string | 
$mark_as_read = true; // bool | 

try {
    $result = $apiInstance->inAppNotificationGetMessage($id, $mark_as_read);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InAppNotificationApi->inAppNotificationGetMessage: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id string
mark_as_read bool [optional]

Return type

\Ringba\Model\MessageResponse

Authorization

No authorization required

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]

inAppNotificationGetMessages

\Ringba\Model\MessagesResponse inAppNotificationGetMessages($page, $page_size, $pagination_key)

Example

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

$apiInstance = new Ringba\Api\InAppNotificationApi(
    // 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()
);
$page = 56; // int | 
$page_size = 56; // int | 
$pagination_key = 56; // int | 

try {
    $result = $apiInstance->inAppNotificationGetMessages($page, $page_size, $pagination_key);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InAppNotificationApi->inAppNotificationGetMessages: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
page int [optional]
page_size int [optional]
pagination_key int [optional]

Return type

\Ringba\Model\MessagesResponse

Authorization

No authorization required

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]

inAppNotificationGetPreviews

\Ringba\Model\PreviewResponse inAppNotificationGetPreviews()

Example

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

$apiInstance = new Ringba\Api\InAppNotificationApi(
    // 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()
);

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

Parameters

This endpoint does not need any parameter.

Return type

\Ringba\Model\PreviewResponse

Authorization

No authorization required

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]

inAppNotificationMarkMessageRead

object inAppNotificationMarkMessageRead($id)

Example

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

$apiInstance = new Ringba\Api\InAppNotificationApi(
    // 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()
);
$id = "id_example"; // string | 

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

Parameters

Name Type Description Notes
id string

Return type

object

Authorization

No authorization required

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]