belenka\Raynetcrm\EmailApi

All URIs are relative to https://app.raynet.cz/api/v2, except if the operation defines another base path.

Method	HTTP request	Description
emailDelete()	DELETE /email/{emailId}/	smazání emailu
emailDetailGet()	GET /email/{emailId}/	detail emailu
emailEdit()	POST /email/{emailId}/	upravení emailu
emailGet()	GET /email/	seznam emailů
emailInsert()	PUT /email/	nový email

`emailDelete()`

emailDelete($email_id)

smazání emailu

Example

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


// Configure API key authorization: instanceName
$config = belenka\Raynetcrm\Configuration::getDefaultConfiguration()->setApiKey('X-Instance-Name', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = belenka\Raynetcrm\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Instance-Name', 'Bearer');

// Configure HTTP basic authorization: basicAuth
$config = belenka\Raynetcrm\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new belenka\Raynetcrm\Api\EmailApi(
    // 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
);
$email_id = 123; // int | ID emailu

try {
    $apiInstance->emailDelete($email_id);
} catch (Exception $e) {
    echo 'Exception when calling EmailApi->emailDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
email_id	int	ID emailu

Return type

void (empty response body)

Authorization

instanceName, basicAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

`emailDetailGet()`

emailDetailGet($email_id)

detail emailu

Získání detailu emailu. Pokud záznam emailu obsahuje volitelná pole, ve výstupu nejsou přítomná pole, která obsahují prázdnou hodnotu (z optimalizačních důvodů). https://app.raynet.cz/api/v2/email/2/

Example

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


// Configure API key authorization: instanceName
$config = belenka\Raynetcrm\Configuration::getDefaultConfiguration()->setApiKey('X-Instance-Name', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = belenka\Raynetcrm\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Instance-Name', 'Bearer');

// Configure HTTP basic authorization: basicAuth
$config = belenka\Raynetcrm\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new belenka\Raynetcrm\Api\EmailApi(
    // 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
);
$email_id = 123; // int | ID emailu

try {
    $apiInstance->emailDetailGet($email_id);
} catch (Exception $e) {
    echo 'Exception when calling EmailApi->emailDetailGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
email_id	int	ID emailu

Return type

void (empty response body)

Authorization

instanceName, basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`emailEdit()`

emailEdit($email_id, $email_edit_dto): \belenka\Raynetcrm\Model\EmailEdit200Response

upravení emailu

Upravení dat emailu

Example

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


// Configure API key authorization: instanceName
$config = belenka\Raynetcrm\Configuration::getDefaultConfiguration()->setApiKey('X-Instance-Name', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = belenka\Raynetcrm\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Instance-Name', 'Bearer');

// Configure HTTP basic authorization: basicAuth
$config = belenka\Raynetcrm\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new belenka\Raynetcrm\Api\EmailApi(
    // 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
);
$email_id = 123; // int | ID emailu
$email_edit_dto = {"title":"Poptávka na ceník","category":89,"priority":"DEFAULT","status":"SCHEDULED","personal":false,"company":2,"businessCase":5,"project":4,"activity":14,"scheduledFrom":"2022-06-11 15:00","scheduledTill":"2022-06-11 16:00","description":"Dobrý den pane Kapre, potřebujeme ceník. Děkuji","tags":"aaa, bbb","customFields":{"VIP_b91d1":true},"participants":[{"id":-123},{"person":4},{"id":119,"owner":true,"role":"FROM","person":8,"company":2,"lead":null}]}; // \belenka\Raynetcrm\Model\EmailEditDto

try {
    $result = $apiInstance->emailEdit($email_id, $email_edit_dto);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EmailApi->emailEdit: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
email_id	int	ID emailu
email_edit_dto	\belenka\Raynetcrm\Model\EmailEditDto		[optional]

Return type

\belenka\Raynetcrm\Model\EmailEdit200Response

Authorization

instanceName, basicAuth

HTTP request headers

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

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

`emailGet()`

emailGet($offset, $limit, $sort_column, $sort_direction, $fulltext, $id, $title, $scheduled_from, $scheduled_till, $completed, $category_id, $status, $owner_id, $person_filter, $company_context_filter, $lead_context_filter, $business_case, $row_info_created_at, $row_info_updated_at, $row_info_last_modified_at, $view, $tags)

seznam emailů

Získání seznamu emailů. Tento seznam může být filtrován, řazen a stránkován za použítí níže uvedených parametrů. https://app.raynet.cz/api/v2/email/?offset=0&limit=1&title[LIKE]=RAY%

Example

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


// Configure API key authorization: instanceName
$config = belenka\Raynetcrm\Configuration::getDefaultConfiguration()->setApiKey('X-Instance-Name', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = belenka\Raynetcrm\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Instance-Name', 'Bearer');

// Configure HTTP basic authorization: basicAuth
$config = belenka\Raynetcrm\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new belenka\Raynetcrm\Api\EmailApi(
    // 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
);
$offset = 0; // int | Zobrazeni zaznamu od zacatku
$limit = 100; // int | Maximální počet vrácených emailů je `1000`
$sort_column = id; // string | 
$sort_direction = ASC; // string | 
$fulltext = myText; // string | Fulltextové vyhledání v seznamu. Operátor se v tomto případě nepoužívá.
$id = 3; // int | Filtrování emailů podle ID. Lze využít operátoru `EQ`, `NE`, `GT`, `GE`, `LT`, `LE`
$title = myTag; // string | Filtrování emailů podle předmětu. Lze využít operátoru `EQ`, `NE`, `LIKE`, `LIKE_NOCASE`
$scheduled_from = 2022-06-01 10:00; // string | Filtrování emailů podle data naplánování (\"od\"). Lze využít operátoru `GT`, `GE`, `LT`, `LE`
$scheduled_till = 2022-06-01 10:00; // string | Filtrování emailů podle data naplánování (\"do\"). Lze využít operátoru `GT`, `GE`, `LT`, `LE`
$completed = 2022-06-01 10:00; // string | Filtrování emailů podle data realizování. Lze využít operátoru `GT`, `GE`, `LT`, `LE`
$category_id = 3; // int | Filtrování emailů podle ID kategorie. Lze využít operátoru `EQ`, `NE`, `GT`, `GE`, `LT`, `LE`
$status = SCHEDULED; // string | Filtrování emailů podle statusu. Lze využít operátoru `EQ`, `NE`, `LIKE`, `LIKE_NOCASE`
$owner_id = 3; // int | Filtrování emailů podle ID kontaktní osoby, která je vlastníkem emailu. Lze využít operátoru `EQ`, `NE`, `GT`, `GE`, `LT`, `LE`
$person_filter = 3; // int | Filtrování emailů podle ID kontaktní osoby, která je participantem. Nelze využít standardních operátorů.
$company_context_filter = 3; // int | Filtrování emailů podle ID klienta, kterého se emaily týkají (klient je napojený v kontextu nebo je participantem). Nelze využít standardních operátorů.
$lead_context_filter = 3; // int | Filtrování emailů podle ID leadu, kterého se emaily týkají (lead je napojený v kontextu nebo je participantem). Nelze využít standardních operátorů.
$business_case = 3; // int | Filtrování emailů podle ID obchodního případu, kterého se emailů týkají. Lze využít operátoru `EQ`, `NE`, `IN`, `NOT_IN`
$row_info_created_at = 2022-06-01 10:00; // string | Filtrování emailů podle data vytvoření. Lze využít operátoru `GT`, `GE`, `LT`, `LE`
$row_info_updated_at = 2022-06-01 10:00; // string | Filtrování emailů podle posledního data upravení. Lze využít operátoru `GT`, `GE`, `LT`, `LE`
$row_info_last_modified_at = 2022-06-01 10:00; // string | Filtrování emailů podle posledního data modifikace (vytvoření nebo upravení). Lze využít operátoru `GT`, `GE`, `LT`, `LE`. Vhodné pro periodickou detekci změn.
$view = rowInfo; // string | Pokud je hodnota rovna `rowInfo`, jsou vráceny pouze stavové informace o záznamu (data vytvoření, upravení, verze, ...). Vhodné pro periodickou detekci změn.
$tags = tags; // string | Filtrování podle štítku. Je možné hledat podle více štítků oddělených čárkou. Záznam potom musí alespoň jeden obsahovat (`tag1,tag2`).

try {
    $apiInstance->emailGet($offset, $limit, $sort_column, $sort_direction, $fulltext, $id, $title, $scheduled_from, $scheduled_till, $completed, $category_id, $status, $owner_id, $person_filter, $company_context_filter, $lead_context_filter, $business_case, $row_info_created_at, $row_info_updated_at, $row_info_last_modified_at, $view, $tags);
} catch (Exception $e) {
    echo 'Exception when calling EmailApi->emailGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
offset	int	Zobrazeni zaznamu od zacatku	[optional]
limit	int	Maximální počet vrácených emailů je `1000`	[optional]
sort_column	string		[optional]
sort_direction	string		[optional]
fulltext	string	Fulltextové vyhledání v seznamu. Operátor se v tomto případě nepoužívá.	[optional]
id	int	Filtrování emailů podle ID. Lze využít operátoru `EQ`, `NE`, `GT`, `GE`, `LT`, `LE`	[optional]
title	string	Filtrování emailů podle předmětu. Lze využít operátoru `EQ`, `NE`, `LIKE`, `LIKE_NOCASE`	[optional]
scheduled_from	string	Filtrování emailů podle data naplánování ("od"). Lze využít operátoru `GT`, `GE`, `LT`, `LE`	[optional]
scheduled_till	string	Filtrování emailů podle data naplánování ("do"). Lze využít operátoru `GT`, `GE`, `LT`, `LE`	[optional]
completed	string	Filtrování emailů podle data realizování. Lze využít operátoru `GT`, `GE`, `LT`, `LE`	[optional]
category_id	int	Filtrování emailů podle ID kategorie. Lze využít operátoru `EQ`, `NE`, `GT`, `GE`, `LT`, `LE`	[optional]
status	string	Filtrování emailů podle statusu. Lze využít operátoru `EQ`, `NE`, `LIKE`, `LIKE_NOCASE`	[optional]
owner_id	int	Filtrování emailů podle ID kontaktní osoby, která je vlastníkem emailu. Lze využít operátoru `EQ`, `NE`, `GT`, `GE`, `LT`, `LE`	[optional]
person_filter	int	Filtrování emailů podle ID kontaktní osoby, která je participantem. Nelze využít standardních operátorů.	[optional]
company_context_filter	int	Filtrování emailů podle ID klienta, kterého se emaily týkají (klient je napojený v kontextu nebo je participantem). Nelze využít standardních operátorů.	[optional]
lead_context_filter	int	Filtrování emailů podle ID leadu, kterého se emaily týkají (lead je napojený v kontextu nebo je participantem). Nelze využít standardních operátorů.	[optional]
business_case	int	Filtrování emailů podle ID obchodního případu, kterého se emailů týkají. Lze využít operátoru `EQ`, `NE`, `IN`, `NOT_IN`	[optional]
row_info_created_at	string	Filtrování emailů podle data vytvoření. Lze využít operátoru `GT`, `GE`, `LT`, `LE`	[optional]
row_info_updated_at	string	Filtrování emailů podle posledního data upravení. Lze využít operátoru `GT`, `GE`, `LT`, `LE`	[optional]
row_info_last_modified_at	string	Filtrování emailů podle posledního data modifikace (vytvoření nebo upravení). Lze využít operátoru `GT`, `GE`, `LT`, `LE`. Vhodné pro periodickou detekci změn.	[optional]
view	string	Pokud je hodnota rovna `rowInfo`, jsou vráceny pouze stavové informace o záznamu (data vytvoření, upravení, verze, ...). Vhodné pro periodickou detekci změn.	[optional]
tags	string	Filtrování podle štítku. Je možné hledat podle více štítků oddělených čárkou. Záznam potom musí alespoň jeden obsahovat (`tag1,tag2`).	[optional]

Return type

void (empty response body)

Authorization

instanceName, basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`emailInsert()`

emailInsert($email_insert_dto): \belenka\Raynetcrm\Model\Insert201Response

nový email

Založení nového emailu

Example

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


// Configure API key authorization: instanceName
$config = belenka\Raynetcrm\Configuration::getDefaultConfiguration()->setApiKey('X-Instance-Name', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = belenka\Raynetcrm\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Instance-Name', 'Bearer');

// Configure HTTP basic authorization: basicAuth
$config = belenka\Raynetcrm\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new belenka\Raynetcrm\Api\EmailApi(
    // 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
);
$email_insert_dto = {"title":"Poptávka na ceník","priority":"DEFAULT","category":1,"owner":4,"person":2,"company":3,"scheduledFrom":"2022-06-11 15:00","scheduledTill":"2022-06-11 16:00","description":"Dobrý den pane Kapre, potřebujeme ceník. Děkuji","tags":["stitek 1","stitek 2"]}; // \belenka\Raynetcrm\Model\EmailInsertDto

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

Parameters

Name	Type	Description	Notes
email_insert_dto	\belenka\Raynetcrm\Model\EmailInsertDto		[optional]

Return type

\belenka\Raynetcrm\Model\Insert201Response

Authorization

instanceName, basicAuth

HTTP request headers

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

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

EmailApi.md

EmailApi.md

belenka\Raynetcrm\EmailApi

`emailDelete()`

Example

Parameters

Return type

Authorization

HTTP request headers

`emailDetailGet()`

Example

Parameters

Return type

Authorization

HTTP request headers

`emailEdit()`

Example

Parameters

Return type

Authorization

HTTP request headers

`emailGet()`

Example

Parameters

Return type

Authorization

HTTP request headers

`emailInsert()`

Example

Parameters

Return type

Authorization

HTTP request headers

Files

EmailApi.md

Latest commit

History

EmailApi.md

File metadata and controls

belenka\Raynetcrm\EmailApi

emailDelete()

Example

Parameters

Return type

Authorization

HTTP request headers

emailDetailGet()

Example

Parameters

Return type

Authorization

HTTP request headers

emailEdit()

Example

Parameters

Return type

Authorization

HTTP request headers

emailGet()

Example

Parameters

Return type

Authorization

HTTP request headers

emailInsert()

Example

Parameters

Return type

Authorization

HTTP request headers

`emailDelete()`

`emailDetailGet()`

`emailEdit()`

`emailGet()`

`emailInsert()`