Skip to content

Latest commit

 

History

History
369 lines (261 loc) · 14.3 KB

GDPRApi.md

File metadata and controls

369 lines (261 loc) · 14.3 KB

belenka\Raynetcrm\GDPRApi

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

Method HTTP request Description
gdprDetailGet() GET /gdpr/{gdprId}/ detail právního titlulu
gdprEdit() POST /gdpr/{gdprId}/ upravení právního titulu
gdprGet() GET /gdpr/ seznam právních titulů
gdprInsert() PUT /gdpr/ nový právní titul
gdprInvalidEdit() POST /gdpr/{gdprId}/invalid/ zneplatnění právního titulu

gdprDetailGet()

gdprDetailGet($gdpr_id)

detail právního titlulu

Získání detailu právního titlulu. https://app.raynet.cz/api/v2/gdpr/1/

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\GDPRApi(
    // 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
);
$gdpr_id = 123; // int | ID právního titulu

try {
    $apiInstance->gdprDetailGet($gdpr_id);
} catch (Exception $e) {
    echo 'Exception when calling GDPRApi->gdprDetailGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
gdpr_id int ID právního titulu

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]

gdprEdit()

gdprEdit($gdpr_id, $gdpr_edit_dto)

upravení právního titulu

Upravení dat právního titulu.

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\GDPRApi(
    // 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
);
$gdpr_id = 123; // int | ID právního titulu
$gdpr_edit_dto = {"validFrom":"2022-11-08","validTill":"2022-11-08"}; // \belenka\Raynetcrm\Model\GdprEditDto

try {
    $apiInstance->gdprEdit($gdpr_id, $gdpr_edit_dto);
} catch (Exception $e) {
    echo 'Exception when calling GDPRApi->gdprEdit: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
gdpr_id int ID právního titulu
gdpr_edit_dto \belenka\Raynetcrm\Model\GdprEditDto [optional]

Return type

void (empty response body)

Authorization

instanceName, basicAuth

HTTP request headers

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

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

gdprGet()

gdprGet($offset, $limit, $sort_column, $sort_direction, $id, $company, $lead, $person, $gdpr_template, $row_info_created_at, $row_info_updated_at, $row_info_last_modified_at, $view)

seznam právních titulů

Získání seznamu právních titulů k entitě. 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/gdpr/

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\GDPRApi(
    // 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 záznamů je `1000`
$sort_column = gdprTemplate; // string | 
$sort_direction = ASC; // string | 
$id = 3; // int | Filtrování právních titulů podle ID. Lze využít operátoru `EQ`, `NE`, `GT`, `GE`, `LT`, `LE`
$company = 1; // int | Filtrování právních titulů podle klienta. Lze využít operátoru `EQ`, `NE`, `GT`, `GE`, `LT`, `LE`
$lead = 2; // int | Filtrování právních titulů podle leadu. Lze využít operátoru `EQ`, `NE`, `GT`, `GE`, `LT`, `LE`
$person = 10; // int | Filtrování právních titulů podle kontaktní osoby. Lze využít operátoru `EQ`, `NE`, `GT`, `GE`, `LT`, `LE`
$gdpr_template = 141; // int | Filtrování právních titulů podle šablony právního titulu. Lze využít operátoru `EQ`, `NE`, `GT`, `GE`, `LT`, `LE`
$row_info_created_at = 2022-06-01 10:00; // string | Filtrování právních titulů 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í právních titulů podle posledního data upravení klienta. Lze využít operátoru `GT`, `GE`, `LT`, `LE`
$row_info_last_modified_at = 2022-06-01 10:00; // string | Filtrování právních titulů 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.

try {
    $apiInstance->gdprGet($offset, $limit, $sort_column, $sort_direction, $id, $company, $lead, $person, $gdpr_template, $row_info_created_at, $row_info_updated_at, $row_info_last_modified_at, $view);
} catch (Exception $e) {
    echo 'Exception when calling GDPRApi->gdprGet: ', $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 záznamů je `1000` [optional]
sort_column string [optional]
sort_direction string [optional]
id int Filtrování právních titulů podle ID. Lze využít operátoru `EQ`, `NE`, `GT`, `GE`, `LT`, `LE` [optional]
company int Filtrování právních titulů podle klienta. Lze využít operátoru `EQ`, `NE`, `GT`, `GE`, `LT`, `LE` [optional]
lead int Filtrování právních titulů podle leadu. Lze využít operátoru `EQ`, `NE`, `GT`, `GE`, `LT`, `LE` [optional]
person int Filtrování právních titulů podle kontaktní osoby. Lze využít operátoru `EQ`, `NE`, `GT`, `GE`, `LT`, `LE` [optional]
gdpr_template int Filtrování právních titulů podle šablony právního titulu. Lze využít operátoru `EQ`, `NE`, `GT`, `GE`, `LT`, `LE` [optional]
row_info_created_at string Filtrování právních titulů podle data vytvoření. Lze využít operátoru `GT`, `GE`, `LT`, `LE` [optional]
row_info_updated_at string Filtrování právních titulů podle posledního data upravení klienta. Lze využít operátoru `GT`, `GE`, `LT`, `LE` [optional]
row_info_last_modified_at string Filtrování právních titulů 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]

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]

gdprInsert()

gdprInsert($gdpr_insert_dto): \belenka\Raynetcrm\Model\Insert201Response

nový právní titul

Založení nového právního titulu k entitě klient, kontaktní osoba, lead

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\GDPRApi(
    // 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
);
$gdpr_insert_dto = {"person":6,"gdprTemplate":1,"validFrom":"2022-01-01"}; // \belenka\Raynetcrm\Model\GdprInsertDto

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

Parameters

Name Type Description Notes
gdpr_insert_dto \belenka\Raynetcrm\Model\GdprInsertDto [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]

gdprInvalidEdit()

gdprInvalidEdit($gdpr_id)

zneplatnění právního titulu

Zneplatnění právního titulu.

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\GDPRApi(
    // 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
);
$gdpr_id = 123; // int | ID právního titulu

try {
    $apiInstance->gdprInvalidEdit($gdpr_id);
} catch (Exception $e) {
    echo 'Exception when calling GDPRApi->gdprInvalidEdit: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
gdpr_id int ID právního titulu

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]