Skip to content

Latest commit

 

History

History
354 lines (302 loc) · 19.5 KB

README.md

File metadata and controls

354 lines (302 loc) · 19.5 KB
Raw

SwaggerClient-php

Introduction This API is a service provided by E-goi to send transactional messages. Transactional Messaging is a 1-to-1 communication channel, usually from an organization directed to a specific consumer. They can be triggered by: * Actions - The consumer interacts with the organization (ie.: online shopping); * Time - The consumer's actions are time-bounded by the organization (ie.: period of inactivity). Because of the nature of these messages, it is expected that the consumer is interested in the content of these messages. Therefore, they have a different treatment from marketing messages, and have a higher acceptance and opening rate. >DISCLAIMER > >Please notice that this platform is more delicate in regards to the nature and processing of its messages. > >It should NOT be used as a mean of mass marketing, scams, phishing or overall unruly behaviour. > >Failure to comply may lead to limitation of use and even termination of account. ***

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

  • API version: V2
  • Build package: io.swagger.codegen.v3.generators.php.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/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

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

$apiInstance = new Swagger\Client\Api\AlertsApi(
    // 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
);
$id = "id_example"; // string | The id of the Alert Template to edit
$body = new \Swagger\Client\Model\AlertTemplateRequest(); // \Swagger\Client\Model\AlertTemplateRequest | 

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

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

$apiInstance = new Swagger\Client\Api\AlertsApi(
    // 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
);
$body = new \Swagger\Client\Model\AlertTemplateRequest(); // \Swagger\Client\Model\AlertTemplateRequest | 

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

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

$apiInstance = new Swagger\Client\Api\AlertsApi(
    // 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
);
$body = new \Swagger\Client\Model\Body(); // \Swagger\Client\Model\Body | default response

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

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

$apiInstance = new Swagger\Client\Api\AlertsApi(
    // 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
);
$id = "id_example"; // string | The id of the Alert Template

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

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

$apiInstance = new Swagger\Client\Api\AlertsApi(
    // 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
);

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

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

$apiInstance = new Swagger\Client\Api\AlertsApi(
    // 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
);
$id = "id_example"; // string | The id of the Alert Template to remove

try {
    $apiInstance->removeAlertTemplate($id);
} catch (Exception $e) {
    echo 'Exception when calling AlertsApi->removeAlertTemplate: ', $e->getMessage(), PHP_EOL;
}

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

$apiInstance = new Swagger\Client\Api\AlertsApi(
    // 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
);
$body = new \Swagger\Client\Model\CancelAlertRequest(); // \Swagger\Client\Model\CancelAlertRequest | 

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

Documentation for API Endpoints

All URIs are relative to https://slingshot.egoiapp.com/api/

Class Method HTTP request Description
AlertsApi changeAlertTemplate PATCH /v2/alert/template/{id} Change Single Alert Template
AlertsApi createAlertTemplate POST /v2/alert/template Create Alert Template
AlertsApi executeEmailAlert POST /v2/alert/action/execute Execute Alert
AlertsApi listMultiChannel GET /v2/alert/template/{id} Get Single Alert Template
AlertsApi listMultiChannel1 GET /v2/alert/template Get All Alert Template
AlertsApi removeAlertTemplate DELETE /v2/alert/template/{id} Remove Alert Template
AlertsApi stopAlert POST /v2/alert/action/stop Stop Alert
DefaultApi redocStyleDoc GET /v2/redoc
DomainsApi addDomain POST /v2/domain Create New Domain
DomainsApi changeDefaultDomain POST /v2/domain/default Change Default Domain
DomainsApi listDefaultDomain GET /v2/domain/default Get Default Domain
DomainsApi listDomain GET /v2/domain/{id} Get Single Domain
DomainsApi listDomains GET /v2/domain Get All Domains
DomainsApi validateDomain GET /v2/domain/{id}/validate Validate Single Domain
EmailApi sendEmailMessages POST /v2/email/messages/action/send Send an Email Message
GroupsApi listGroups GET /v2/groups Get All Groups
MessageInformationApi listAllEmailMessages GET /v2/email/messages Get All Email Messages
MessageInformationApi listAllSmsMessages GET /v2/sms/messages Get All Sms Messages
MessageInformationApi listSingleEmailMessage GET /v2/email/messages/{id} Get Single Email Messages
MessageInformationApi listSingleSmsMessage GET /v2/sms/messages/{id} Get Single Sms Messages
MultiChannelApi createMultiChannelFlow POST /v2/multi-channel/flow Create Multi-Channel Flow
MultiChannelApi executeMultiChannel POST /v2/multi-channel/execute Execute Multi-Channel
MultiChannelApi listMultiChannel2 GET /v2/multi-channel/flow/{id} Get Single Multi-Channel Flow
MultiChannelApi listMultiChannels GET /v2/multi-channel/flow Get All Multi-Channel Flows
MultiChannelApi removeMultiChannel DELETE /v2/multi-channel/flow/{id} Remove Single Multi-Channel
PushApi addApp POST /v2/apps Create App
PushApi addPushTemplate POST /v2/push/templates Create Push Template
PushApi deleteApp DELETE /v2/apps/{id} Remove App
PushApi deletePushTemplate DELETE /v2/push/templates/{id} Remove Push Template
PushApi listApp GET /v2/apps/{id} Get an App
PushApi listApps GET /v2/apps Get All Apps
PushApi listPushTemplate GET /v2/push/templates/{id} Get an Push Template
PushApi listPushTemplates GET /v2/push/templates Get All Push Templates
PushApi sendPushMessages POST /v2/push/messages/action/send Send a Push Message
PushApi updateApp PUT /v2/apps/{id} Update App
PushApi updatePushTemplate PATCH /v2/push/templates/{id} Update Push Template
ReportsApi produceEmailReport GET /v2/email/reports Get Email Report
ReportsApi produceSmsReport GET /v2/sms/reports Get Sms Report
ScheduleApi cancelScheduledMessage POST /v2/messages/{id}/action/send Cancel a Scheduled Message
SendersApi getEmailSenders GET /v2/email/senders Get All Email Senders
SendersApi getSmsSenders GET /v2/sms/senders Get All Sms Senders
SmsApi sendSmsMessages POST /v2/sms/messages/action/send Send an SMS Message
UtilitiesApi emailValidator POST /v2/emailValidator Email Validator
UtilitiesApi htmlToPdf POST /v2/htmlToPdfConverter HTML to PDF converter
UtilitiesApi pingApi GET /v2/ping Ping API
UtilitiesApi smsLengthCalculator POST /v2/smsLengthCalculator SMS Length Calculator
UtilitiesApi validatePhone GET /v2/validate-phone/{number} Validate Phone
VerifyApi cancelVerify POST /v2/verify/{id}/cancel Cancel Verify Request
VerifyApi getVerify GET /v2/verify/{id} Get Verify Request
VerifyApi requestVerify POST /v2/verify/request Request Verify
VerifyApi resendVerify POST /v2/verify/{id}/resend Resend Verify Code
VerifyApi validateVerifyCode POST /v2/verify/{id}/validate Validate Verify Code
WebhooksApi addWebHook POST /v2/webhooks Create new Webhook
WebhooksApi listWebHooks GET /v2/webhooks Get All Webhooks
WebhooksApi removeWebHook DELETE /v2/webhooks Remove Webhook

Documentation For Models

Documentation For Authorization

ApiKey

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

Author