mobieve/mobieve-sdk-php

v1.0.4 2019-12-10 13:32 UTC

Requires

• php: >=5.5
• ext-curl: *
• ext-json: *
• ext-mbstring: *
• guzzlehttp/guzzle: ^6.2

Requires (Dev)

• friendsofphp/php-cs-fixer: ~1.12
• phpunit/phpunit: ^4.8
• squizlabs/php_codesniffer: ~2.6

proprietary

• OpenAPI-Generator contributors

• php
• rest
• api
• sdk
• openapitools
• openapi-generator

README

Notification API for Mobieve Services

This PHP package is automatically generated by the OpenAPI Generator project:

• API version: 2019-12-05T21:13:11Z
• Package version: 1.0.2
• Build package: org.openapitools.codegen.languages.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/mobieve/mobieve-sdk-php.git"
    }
  ],
  "require": {
    "mobieve/mobieve-sdk-php": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/mobieve-sdk-php/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

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

// Configure API key authorization: BearerToken
$config = Mobieve\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Mobieve\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Mobieve\Api\NotifierApi(
    // 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
);
$message = new \Mobieve\Model\Message(); // \Mobieve\Model\Message | 

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

?>

Documentation for API Endpoints

All URIs are relative to https://38m715k2fa.execute-api.sa-east-1.amazonaws.com/v1

Class	Method	HTTP request	Description
NotifierApi	createMessage	POST /messages
NotifierApi	createTemplate	POST /templates
NotifierApi	getChannels	GET /channels
NotifierApi	getMessage	GET /messages/{id}
NotifierApi	getMessages	GET /messages
NotifierApi	getTemplates	GET /templates
NotifierApi	updateTemplate	POST /templates/{id}

Documentation For Models

• ArrayOfObjects
• Message
• ModelEmpty
• Template

Documentation For Authorization

BearerToken

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

Author