Skip to content

Latest commit

 

History

History
335 lines (232 loc) · 10.7 KB

EmailRulesApi.md

File metadata and controls

335 lines (232 loc) · 10.7 KB
Raw

Arta\Client\EmailRulesApi

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

Method HTTP request Description
emailRulesCreate() POST /email_rules Create an Email Rule
emailRulesDelete() DELETE /email_rules/{email_rule_id} Delete an Email Rule
emailRulesGet() GET /email_rules/{email_rule_id} Get an Email Rule
emailRulesList() GET /email_rules List Email Rules
emailRulesUpdate() PATCH /email_rules/{email_rule_id} Update an Email Rule

emailRulesCreate()

emailRulesCreate($authorization, $email_rules_create_request): \Arta\Client\Model\EmailRule

Create an Email Rule

response

Example

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


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


$apiInstance = new Arta\Client\Api\EmailRulesApi(
    // 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
);
$authorization = ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y; // string | Authorize your API calls with an Arta API token
$email_rules_create_request = new \Arta\Client\Model\EmailRulesCreateRequest(); // \Arta\Client\Model\EmailRulesCreateRequest

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

Parameters

Name Type Description Notes
authorization string Authorize your API calls with an Arta API token
email_rules_create_request \Arta\Client\Model\EmailRulesCreateRequest [optional]

Return type

\Arta\Client\Model\EmailRule

Authorization

apiKeyAuth

HTTP request headers

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

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

emailRulesDelete()

emailRulesDelete($authorization, $email_rule_id)

Delete an Email Rule

Delete an Email Rule

Example

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


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


$apiInstance = new Arta\Client\Api\EmailRulesApi(
    // 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
);
$authorization = ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y; // string | Authorize your API calls with an Arta API token
$email_rule_id = 56; // int | email_rule_id parameter

try {
    $apiInstance->emailRulesDelete($authorization, $email_rule_id);
} catch (Exception $e) {
    echo 'Exception when calling EmailRulesApi->emailRulesDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
authorization string Authorize your API calls with an Arta API token
email_rule_id int email_rule_id parameter

Return type

void (empty response body)

Authorization

apiKeyAuth

HTTP request headers

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

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

emailRulesGet()

emailRulesGet($authorization, $email_rule_id): \Arta\Client\Model\EmailRule

Get an Email Rule

Retrieve an existing Email Rule request

Example

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


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


$apiInstance = new Arta\Client\Api\EmailRulesApi(
    // 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
);
$authorization = ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y; // string | Authorize your API calls with an Arta API token
$email_rule_id = 56; // int | email_rule_id parameter

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

Parameters

Name Type Description Notes
authorization string Authorize your API calls with an Arta API token
email_rule_id int email_rule_id parameter

Return type

\Arta\Client\Model\EmailRule

Authorization

apiKeyAuth

HTTP request headers

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

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

emailRulesList()

emailRulesList($authorization, $page_size, $page): \Arta\Client\Model\EmailRuleList

List Email Rules

Retrieve a paginated collection of Email Rules belonging to your Organization

Example

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


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


$apiInstance = new Arta\Client\Api\EmailRulesApi(
    // 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
);
$authorization = ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y; // string | Authorize your API calls with an Arta API token
$page_size = 20; // int | Results per page (max 50)
$page = 1; // int | Page number of the results to fetch.

try {
    $result = $apiInstance->emailRulesList($authorization, $page_size, $page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EmailRulesApi->emailRulesList: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
authorization string Authorize your API calls with an Arta API token
page_size int Results per page (max 50) [optional] [default to 20]
page int Page number of the results to fetch. [optional] [default to 1]

Return type

\Arta\Client\Model\EmailRuleList

Authorization

apiKeyAuth

HTTP request headers

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

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

emailRulesUpdate()

emailRulesUpdate($authorization, $email_rule_id, $email_rules_update_request): \Arta\Client\Model\EmailRule

Update an Email Rule

Update an existing Email Rule request

Example

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


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


$apiInstance = new Arta\Client\Api\EmailRulesApi(
    // 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
);
$authorization = ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y; // string | Authorize your API calls with an Arta API token
$email_rule_id = 56; // int | email_rule_id parameter
$email_rules_update_request = new \Arta\Client\Model\EmailRulesUpdateRequest(); // \Arta\Client\Model\EmailRulesUpdateRequest

try {
    $result = $apiInstance->emailRulesUpdate($authorization, $email_rule_id, $email_rules_update_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EmailRulesApi->emailRulesUpdate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
authorization string Authorize your API calls with an Arta API token
email_rule_id int email_rule_id parameter
email_rules_update_request \Arta\Client\Model\EmailRulesUpdateRequest [optional]

Return type

\Arta\Client\Model\EmailRule

Authorization

apiKeyAuth

HTTP request headers

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

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