Bumbal Communication Server Administration API documentation

This PHP package is automatically generated by the Swagger Codegen project:

• API version: 1.0
• Build package: io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.4.0 and later

Installation & Usage

Composer

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

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/bumbal/communication-admin-api.git"
    }
  ],
  "require": {
    "bumbal/communication-admin-api": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to//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: api_key
BumbalCommunicationAdmin\Configuration::getDefaultConfiguration()->setApiKey('ApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// BumbalCommunicationAdmin\Configuration::getDefaultConfiguration()->setApiKeyPrefix('ApiKey', 'Bearer');

$api_instance = new BumbalCommunicationAdmin\Api\ActivityApi();
$body = new \BumbalCommunicationAdmin\Model\TriggerMessageArgsModel(); // \BumbalCommunicationAdmin\Model\TriggerMessageArgsModel | Schedule Message Args

try {
    $result = $api_instance->generateMessageForActivity($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ActivityApi->generateMessageForActivity: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://communication.bumbal.eu/admin/v1

Class	Method	HTTP request	Description
ActivityApi	generateMessageForActivity	POST /activity/generate-message	Generate a message for an Activity
ActivityApi	registerActivity	POST /activity/register	Register an Activity
ActivityApi	retrieveActivity	GET /activity/{activityId}	Find activity by ID
ActivityApi	triggerMessageForActivity	POST /activity/trigger-message	Trigger a message for an Activity
DeliverymethodsApi	listDeliveryMethods	GET /delivery-method	List all DeliveryMethods
MappingApi	createMapping	POST /mapping	Create a Mapping
MappingApi	deleteMapping	DELETE /mapping/{mappingId}	Delete a mapping
MappingApi	retrieveListMapping	PUT /mapping	Retrieve List of Mapping
MappingApi	retrieveMapping	GET /mapping/{mappingId}	Retrieve a mapping
MappingApi	updateMapping	PUT /mapping/{mappingId}	Update an mapping
MessagesApi	messageRetrieve	GET /message/{messageId}	Retrieve a Message
MessagesApi	retrieveListMessages	PUT /message	Retrieve List of Messages
MessagetypesApi	listMessageTypes	GET /message-type	List all MessageTypes
MessagevariablesApi	createMessageVariable	POST /message-variable	Create a MessageVariable
MessagevariablesApi	deleteMessageVariable	DELETE /message-variable/{messageVariableId}	Delete a message variables
MessagevariablesApi	retrieveListMessageVariables	PUT /message-variable	Retrieve List of Message Variables
MessagevariablesApi	retrieveMessageVariable	GET /message-variable/{messageVariableId}	Retrieve a message variable
MessagevariablesApi	updateMessageVariable	PUT /message-variable/{messageVariableId}	Update an MessageVariable
SettingsApi	retrieveListSettings	PUT /setting	Retrieve List of Settings
SettingsApi	settingRetrieve	GET /setting/{settingId}	Retrieve a Setting
SettingsApi	settingsUpdate	PUT /setting/{settingId}	Update a Setting
TemplateApi	createTemplate	POST /template	Create a Template
TemplateApi	deleteTemplate	DELETE /template/{templateId}	Delete a Template
TemplateApi	retrieveListTemplate	PUT /template	Retrieve List of Templates
TemplateApi	retrieveTemplate	GET /template/{templateId}	Retrieve a Template
TemplateApi	updateTemplate	PUT /template/{templateId}	Update an Template

Documentation For Models

• ActivityModel
• ActivityOptionsModel
• ApiResponse
• DeliveryMethodModel
• MappingFiltersModel
• MappingListResponse
• MappingModel
• MappingOptionsModel
• MappingRetrieveListArguments
• MessageContentModel
• MessageFiltersModel
• MessageHistoryModel
• MessageModel
• MessageOptionsModel
• MessageRetrieveListArguments
• MessageTypeModel
• MessageVariableFiltersModel
• MessageVariableModel
• MessageVariableOptionsModel
• MessageVariableRetrieveListArguments
• ScheduledJobModel
• SettingFiltersModel
• SettingListResponse
• SettingModel
• SettingOptionsModel
• SettingRetrieveListArguments
• TemplateFiltersModel
• TemplateListResponse
• TemplateModel
• TemplateOptionsModel
• TemplateRetrieveListArguments
• TriggerMessageArgsModel

Documentation For Authorization

api_key

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

Author

[email protected]