Skip to content

Latest commit

 

History

History
131 lines (90 loc) · 4.26 KB

BrandMailtemplateApi.md

File metadata and controls

131 lines (90 loc) · 4.26 KB

EmonsiteApi\BrandMailtemplateApi

All URIs are relative to http://localhost.

Method HTTP request Description
getBrandMailtemplateCollection() GET /brand_mailtemplates Retrieves the collection of BrandMailtemplateOutputDto resources.
getBrandMailtemplateItem() GET /brand_mailtemplates/{id} Retrieves a BrandMailtemplateOutputDto resource.

getBrandMailtemplateCollection()

getBrandMailtemplateCollection($page, $itemsPerPage): \EmonsiteApi\Models\GetBrandMailtemplateCollection200Response

Retrieves the collection of BrandMailtemplateOutputDto resources.

Example

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


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


$apiInstance = new EmonsiteApi\Api\BrandMailtemplateApi(
    // 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
);
$page = 1; // int | The collection page number
$itemsPerPage = 30; // int | The number of items per page

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

Parameters

Name Type Description Notes
page int The collection page number [optional] [default to 1]
itemsPerPage int The number of items per page [optional] [default to 30]

Return type

\EmonsiteApi\Models\GetBrandMailtemplateCollection200Response

Authorization

apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/ld+json, application/json, text/html

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getBrandMailtemplateItem()

getBrandMailtemplateItem($id): \EmonsiteApi\Models\BrandMailtemplateF7868dc2d61d9d5900e2966c0baf4626Jsonld

Retrieves a BrandMailtemplateOutputDto resource.

Example

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


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


$apiInstance = new EmonsiteApi\Api\BrandMailtemplateApi(
    // 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

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

Parameters

Name Type Description Notes
id string

Return type

\EmonsiteApi\Models\BrandMailtemplateF7868dc2d61d9d5900e2966c0baf4626Jsonld

Authorization

apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/ld+json, application/json, text/html

[Back to top] [Back to API list] [Back to Model list] [Back to README]