OpenAPIClient-php

API for managing email queues and sending emails.

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

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

{
  "repositories": [
    {
      "type": "vcs",
      "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:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

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




$apiInstance = new OpenAPI\Client\Api\DefaultApi(
    // 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()
);
$create_email_queue_request = new \OpenAPI\Client\Model\CreateEmailQueueRequest(); // \OpenAPI\Client\Model\CreateEmailQueueRequest

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

API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
DefaultApi	createEmailQueue	POST /email-queues	Create a new email queue

Models

• CreateEmailQueue201Response
• CreateEmailQueue201ResponseData
• CreateEmailQueue201ResponseDataLinks
• CreateEmailQueueRequest
• CreateEmailQueueRequestData
• CreateEmailQueueRequestDataAttributes
• Email

Authorization

Endpoints do not require authorization.

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

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

• API version: 1.0.0
  • Generator version: 7.12.0-SNAPSHOT
• Build package: org.openapitools.codegen.languages.PhpClientCodegen