Skip to content

Latest commit

 

History

History
288 lines (195 loc) · 8.08 KB

EmailSubscriberApi.md

File metadata and controls

288 lines (195 loc) · 8.08 KB

OpenAPI\Client\EmailSubscriberApi

All URIs are relative to https://api.wall.et, except if the operation defines another base path.

Method HTTP request Description
archiveEmailSubscriber() DELETE /v2/emailSubscriber/{id} Archive email subscriber
createEmailSubscriber() POST /v2/emailSubscriber Create email subscriber
fetchAllEmailSubscribers() GET /v2/emailSubscriber/all Fetch all email subscribers
restoreEmailSubscriber() PATCH /v2/emailSubscriber/{id} Restore email subscriber
updateEmailSubscriber() PUT /v2/emailSubscriber/{id} Update email subscriber

archiveEmailSubscriber()

archiveEmailSubscriber($id): \OpenAPI\Client\Model\EmailSubscriber

Archive email subscriber

Example

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



$apiInstance = new OpenAPI\Client\Api\EmailSubscriberApi(
    // 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()
);
$id = NULL; // mixed

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

Parameters

Name Type Description Notes
id mixed

Return type

\OpenAPI\Client\Model\EmailSubscriber

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

createEmailSubscriber()

createEmailSubscriber($wt_email_subscriber_create_params): \OpenAPI\Client\Model\EmailSubscriber

Create email subscriber

Example

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



$apiInstance = new OpenAPI\Client\Api\EmailSubscriberApi(
    // 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()
);
$wt_email_subscriber_create_params = new \OpenAPI\Client\Model\WTEmailSubscriberCreateParams(); // \OpenAPI\Client\Model\WTEmailSubscriberCreateParams

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

Parameters

Name Type Description Notes
wt_email_subscriber_create_params \OpenAPI\Client\Model\WTEmailSubscriberCreateParams

Return type

\OpenAPI\Client\Model\EmailSubscriber

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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

fetchAllEmailSubscribers()

fetchAllEmailSubscribers($start_date_time, $end_date_time, $is_archive_included): mixed

Fetch all email subscribers

Example

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



$apiInstance = new OpenAPI\Client\Api\EmailSubscriberApi(
    // 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()
);
$start_date_time = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date_time = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$is_archive_included = True; // bool

try {
    $result = $apiInstance->fetchAllEmailSubscribers($start_date_time, $end_date_time, $is_archive_included);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EmailSubscriberApi->fetchAllEmailSubscribers: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date_time \DateTime [optional]
end_date_time \DateTime [optional]
is_archive_included bool [optional]

Return type

mixed

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

restoreEmailSubscriber()

restoreEmailSubscriber($id): \OpenAPI\Client\Model\EmailSubscriber

Restore email subscriber

Example

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



$apiInstance = new OpenAPI\Client\Api\EmailSubscriberApi(
    // 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()
);
$id = NULL; // mixed

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

Parameters

Name Type Description Notes
id mixed

Return type

\OpenAPI\Client\Model\EmailSubscriber

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

updateEmailSubscriber()

updateEmailSubscriber($id, $wt_email_subscriber_update_params): \OpenAPI\Client\Model\EmailSubscriber

Update email subscriber

Example

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



$apiInstance = new OpenAPI\Client\Api\EmailSubscriberApi(
    // 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()
);
$id = NULL; // mixed
$wt_email_subscriber_update_params = new \OpenAPI\Client\Model\WTEmailSubscriberUpdateParams(); // \OpenAPI\Client\Model\WTEmailSubscriberUpdateParams

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

Parameters

Name Type Description Notes
id mixed
wt_email_subscriber_update_params \OpenAPI\Client\Model\WTEmailSubscriberUpdateParams

Return type

\OpenAPI\Client\Model\EmailSubscriber

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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