Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dadapush/dadapush-php-client

DaDaPush Client For PHP
https://github.com/dadapush/dadapush-php-client

dadapush notification-api notifications push push-notifications

Last synced: about 1 month ago
JSON representation

DaDaPush Client For PHP

Awesome Lists containing this project

README

        

# DaDaPushClient

DaDaPush: Real-time Notifications App

Send real-time notifications through our API without coding and maintaining your own app for iOS or Android devices.

This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: v1
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.PhpClientCodegen
For more information, please visit [https://www.dadapush.com](https://www.dadapush.com)

## Requirements

PHP 5.5 and later

## Installation & Usage

### Composer

To install the bindings via [Composer](http://getcomposer.org/), add the following to `composer.json`:

```json
{
"require": {
"dadapush/dadapush-php-client": "1.0.0"
}
}
```

or use git repo
```json
{
"repositories": [
{
"type": "vcs",
"url": "https://github.com/dadapush/dadapush-php-client.git"
}
],
"require": {
"dadapush/dadapush-php-client": "*@dev"
}
}
```

Then run `composer install`

### Manual Installation

Download the files and include `autoload.php`:

```php
require_once('/path/to/DaDaPushClient/vendor/autoload.php');
```

## Tests

To run the unit tests:

```bash
composer install
./vendor/bin/phpunit
```

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```php
createMessage($body, $x_channel_token);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DaDaPushMessageApi->createMessage: ', $e->getMessage(), PHP_EOL;
}

?>
```

## Documentation for API Endpoints

All URIs are relative to *https://www.dadapush.com*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DaDaPushMessageApi* | [**createMessage**](docs/Api/DaDaPushMessageApi.md#createmessage) | **POST** /api/v1/message | push Message to a Channel
*DaDaPushMessageApi* | [**deleteMessage**](docs/Api/DaDaPushMessageApi.md#deletemessage) | **DELETE** /api/v1/message/{messageId} | delete a Channel Message
*DaDaPushMessageApi* | [**getMessage**](docs/Api/DaDaPushMessageApi.md#getmessage) | **GET** /api/v1/message/{messageId} | get a Channel Message
*DaDaPushMessageApi* | [**getMessages**](docs/Api/DaDaPushMessageApi.md#getmessages) | **GET** /api/v1/messages | get Message List

## Documentation For Models

- [Action](docs/Model/Action.md)
- [MessageObject](docs/Model/MessageObject.md)
- [MessagePushRequest](docs/Model/MessagePushRequest.md)
- [MessagePushResponse](docs/Model/MessagePushResponse.md)
- [PageResponseOfMessageObject](docs/Model/PageResponseOfMessageObject.md)
- [Result](docs/Model/Result.md)
- [ResultOfMessageObject](docs/Model/ResultOfMessageObject.md)
- [ResultOfMessagePushResponse](docs/Model/ResultOfMessagePushResponse.md)
- [ResultOfPageResponseOfMessageObject](docs/Model/ResultOfPageResponseOfMessageObject.md)

## Author

[email protected]