OpenAPI\Client\ContactsApi

All URIs are relative to http://localhost, except if the operation defines another base path.

Method	HTTP request	Description
contactsCreate()	POST /api/v1/Contacts/contact	Creates new contact
contactsDelete()	DELETE /api/v1/Contacts/{id}	Removes contact by id
contactsGet()	GET /api/v1/Contacts/{id}	Returns contact group by id
contactsGetByGroup()	GET /api/v1/Contacts/group/{groupId}/contacts	Returns contacts by group id
contactsGetList()	GET /api/v1/Contacts/subscription/{subscriptionId}/contacts	Allows to search for contacts
contactsUpdate()	PUT /api/v1/Contacts/{id}	Updates contact by id

`contactsCreate()`

contactsCreate($create_contact_vm): \OpenAPI\Client\cloud\fastreport\model\ContactVM

Creates new contact

Example

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


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\ContactsApi(
    // 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
);
$create_contact_vm = new \OpenAPI\Client\cloud\fastreport\model\CreateContactVM(); // \OpenAPI\Client\cloud\fastreport\model\CreateContactVM | 

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

Parameters

Name	Type	Description	Notes
create_contact_vm	\OpenAPI\Client\cloud\fastreport\model\CreateContactVM		[optional]

Return type

\OpenAPI\Client\cloud\fastreport\model\ContactVM

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: application/json, text/json, application/*+json
Accept: application/json

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

`contactsDelete()`

contactsDelete($id)

Removes contact by id

Example

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


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\ContactsApi(
    // 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 {
    $apiInstance->contactsDelete($id);
} catch (Exception $e) {
    echo 'Exception when calling ContactsApi->contactsDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string

Return type

void (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`contactsGet()`

contactsGet($id): \OpenAPI\Client\cloud\fastreport\model\ContactVM

Returns contact group by id

Example

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


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\ContactsApi(
    // 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->contactsGet($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactsApi->contactsGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string

Return type

\OpenAPI\Client\cloud\fastreport\model\ContactVM

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`contactsGetByGroup()`

contactsGetByGroup($group_id, $skip, $take): \OpenAPI\Client\cloud\fastreport\model\ContactsVM

Returns contacts by group id

Example

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


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\ContactsApi(
    // 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
);
$group_id = 'group_id_example'; // string | 
$skip = 0; // int | 
$take = 10; // int | 

try {
    $result = $apiInstance->contactsGetByGroup($group_id, $skip, $take);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactsApi->contactsGetByGroup: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Notes
group_id	string
skip	int	[optional] [default to 0]
take	int	[optional] [default to 10]

Return type

\OpenAPI\Client\cloud\fastreport\model\ContactsVM

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`contactsGetList()`

contactsGetList($subscription_id, $skip, $take, $search_pattern): \OpenAPI\Client\cloud\fastreport\model\ContactsVM

Allows to search for contacts

Example

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


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\ContactsApi(
    // 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
);
$subscription_id = 'subscription_id_example'; // string | 
$skip = 0; // int | 
$take = 10; // int | 
$search_pattern = 'search_pattern_example'; // string | 

try {
    $result = $apiInstance->contactsGetList($subscription_id, $skip, $take, $search_pattern);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactsApi->contactsGetList: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Notes
subscription_id	string
skip	int	[optional] [default to 0]
take	int	[optional] [default to 10]
search_pattern	string	[optional]

Return type

\OpenAPI\Client\cloud\fastreport\model\ContactsVM

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`contactsUpdate()`

contactsUpdate($id, $update_contact_vm): \OpenAPI\Client\cloud\fastreport\model\ContactVM

Updates contact by id

Example

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


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\ContactsApi(
    // 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 | 
$update_contact_vm = new \OpenAPI\Client\cloud\fastreport\model\UpdateContactVM(); // \OpenAPI\Client\cloud\fastreport\model\UpdateContactVM | 

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

Parameters

Name	Type	Description	Notes
id	string
update_contact_vm	\OpenAPI\Client\cloud\fastreport\model\UpdateContactVM		[optional]

Return type

\OpenAPI\Client\cloud\fastreport\model\ContactVM

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: application/json, text/json, application/*+json
Accept: application/json

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

Files

ContactsApi.md

Latest commit

History

ContactsApi.md

File metadata and controls

OpenAPI\Client\ContactsApi

contactsCreate()

Example

Parameters

Return type

Authorization

HTTP request headers

contactsDelete()

Example

Parameters

Return type

Authorization

HTTP request headers

contactsGet()

Example

Parameters

Return type

Authorization

HTTP request headers

contactsGetByGroup()

Example

Parameters

Return type

Authorization

HTTP request headers

contactsGetList()

Example

Parameters

Return type

Authorization

HTTP request headers

contactsUpdate()

Example

Parameters

Return type

Authorization

HTTP request headers

`contactsCreate()`

`contactsDelete()`

`contactsGet()`

`contactsGetByGroup()`

`contactsGetList()`

`contactsUpdate()`