2017 © Pedro Peláez
 

library email-sdk-php

image

revenuewire/email-sdk-php

  • Wednesday, February 21, 2018
  • by swang
  • Repository
  • 1 Watchers
  • 0 Stars
  • 331 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 0 Forks
  • 0 Open issues
  • 5 Versions
  • 0 % Grown

The README.md

SwaggerClient-php

An email service, (*1)

This PHP package is automatically generated by the Swagger Codegen project:, (*2)

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

Requirements

PHP 5.4.0 and later, (*3)

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:, (*4)

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

Then run composer install, (*5)

Manual Installation

Download the files and include autoload.php:, (*6)

    require_once('/path/to/SwaggerClient-php/autoload.php');

Tests

To run the unit tests:, (*7)

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:, (*8)

setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');
// Configure API key authorization: JWTHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Authorization-JWT', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Authorization-JWT', 'Bearer');

$api_instance = new Swagger\Client\Api\EmailsApi();

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

?>

Documentation for API Endpoints

All URIs are relative to https://localhost/v1, (*9)

Class Method HTTP request Description
EmailsApi getEmailTypes GET /types Get a list of email types and variables
EmailsApi sendEmail POST /emails Sending an email directly.
HelloApi hello GET /hello Just say hello
ResourcesApi addResource POST /resources
ResourcesApi deleteResource DELETE /resources/{id}
ResourcesApi getResource GET /resources/{id}
ResourcesApi getResources GET /resources
ResourcesApi resourcesUploadPost POST /resources/upload
ResourcesApi updateResource PUT /resources/{id}
TemplatesApi addNewContent POST /templates/{id}/contents
TemplatesApi addTemplate POST /templates
TemplatesApi deleteContent DELETE /templates/{id}/contents/{contentId}
TemplatesApi deleteTemplate DELETE /templates/{id}
TemplatesApi getContent GET /templates/{id}/contents/{contentId}
TemplatesApi getContents GET /templates/{id}/contents
TemplatesApi getTemplate GET /templates/{id}
TemplatesApi getTemplates GET /templates
TemplatesApi previewTemplate POST /templates/{id}/preview Get preview of the content
TemplatesApi updateContent PUT /templates/{id}/contents/{contentId} Update Template Content
TemplatesApi updateTemplate PUT /templates/{id}

Documentation For Models

Documentation For Authorization

APIKeyHeader

  • Type: API key
  • API key parameter name: X-API-KEY
  • Location: HTTP header

JWTHeader

  • Type: API key
  • API key parameter name: X-Authorization-JWT
  • Location: HTTP header

Author

The Versions

21/02 2018

dev-master

9999999-dev http://swagger.io

  Sources   Download

proprietary

The Requires

  • php >=5.4
  • ext-curl *
  • ext-json *
  • ext-mbstring *

 

The Development Requires

by Swagger and contributors

api php swagger sdk

19/04 2017

v1.3

1.3.0.0 http://swagger.io

  Sources   Download

proprietary

The Requires

  • php >=5.4
  • ext-curl *
  • ext-json *
  • ext-mbstring *

 

The Development Requires

by Swagger and contributors

api php swagger sdk

19/04 2017

v1.2

1.2.0.0 http://swagger.io

  Sources   Download

proprietary

The Requires

  • php >=5.4
  • ext-curl *
  • ext-json *
  • ext-mbstring *

 

The Development Requires

by Swagger and contributors

api php swagger sdk

18/04 2017

v1.1

1.1.0.0 http://swagger.io

  Sources   Download

proprietary

The Requires

  • php >=5.4
  • ext-curl *
  • ext-json *
  • ext-mbstring *

 

The Development Requires

by Swagger and contributors

api php swagger sdk

10/04 2017

v1.0

1.0.0.0 http://swagger.io

  Sources   Download

proprietary

The Requires

  • php >=5.4
  • ext-curl *
  • ext-json *
  • ext-mbstring *

 

The Development Requires

by Swagger and contributors

api php swagger sdk