Skip to content

ContactApi.md

Latest commit

 

History

History
335 lines (224 loc) · 9.31 KB

ContactApi.md

File metadata and controls

335 lines (224 loc) · 9.31 KB

SynergiTech\Iplicit\ContactApi

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

Method HTTP request Description
createContact() POST /api/Contact Create a contact
deleteContact() DELETE /api/Contact/{idOrIntRef} Delete a contact
getContact() GET /api/Contact/{idOrIntRef} Get a contact
lockContact() POST /api/Contact/{idOrIntRef}/lock Lock the contact
unlockContact() POST /api/Contact/{idOrIntRef}/unlock Unlock the contact
updateContact() PATCH /api/Contact/{idOrIntRef} Update a contact

createContact()

createContact($contactCreate): string

Create a contact

Example

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



$apiInstance = new SynergiTech\Iplicit\Api\ContactApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$contactCreate = new \SynergiTech\Iplicit\Model\ContactCreate(); // \SynergiTech\Iplicit\Model\ContactCreate

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

Parameters

Name Type Description Notes
contactCreate \SynergiTech\Iplicit\Model\ContactCreate [optional]

Return type

string

Authorization

No authorization required

HTTP request headers

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

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

deleteContact()

deleteContact($idOrIntRef)

Delete a contact

Example

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



$apiInstance = new SynergiTech\Iplicit\Api\ContactApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$idOrIntRef = 'idOrIntRef_example'; // string | Id or <a href=\"https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact

try {
    $apiInstance->deleteContact($idOrIntRef);
} catch (Exception $e) {
    echo 'Exception when calling ContactApi->deleteContact: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
idOrIntRef string Id or <a href=&quot;https://docs.iplicit.com/dev/guide/identifiers/index.html\&quot;&gt;internal reference</a> of the contact

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

getContact()

getContact($idOrIntRef): \SynergiTech\Iplicit\Model\ContactRead

Get a contact

Example

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



$apiInstance = new SynergiTech\Iplicit\Api\ContactApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$idOrIntRef = 'idOrIntRef_example'; // string | Id or <a href=\"https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact

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

Parameters

Name Type Description Notes
idOrIntRef string Id or <a href=&quot;https://docs.iplicit.com/dev/guide/identifiers/index.html\&quot;&gt;internal reference</a> of the contact

Return type

\SynergiTech\Iplicit\Model\ContactRead

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

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

lockContact()

lockContact($idOrIntRef)

Lock the contact

Example

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



$apiInstance = new SynergiTech\Iplicit\Api\ContactApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$idOrIntRef = 'idOrIntRef_example'; // string | Id or <a href=\"https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact

try {
    $apiInstance->lockContact($idOrIntRef);
} catch (Exception $e) {
    echo 'Exception when calling ContactApi->lockContact: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
idOrIntRef string Id or <a href=&quot;https://docs.iplicit.com/dev/guide/identifiers/index.html\&quot;&gt;internal reference</a> of the contact

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

unlockContact()

unlockContact($idOrIntRef)

Unlock the contact

Example

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



$apiInstance = new SynergiTech\Iplicit\Api\ContactApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$idOrIntRef = 'idOrIntRef_example'; // string | Id or <a href=\"https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact

try {
    $apiInstance->unlockContact($idOrIntRef);
} catch (Exception $e) {
    echo 'Exception when calling ContactApi->unlockContact: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
idOrIntRef string Id or <a href=&quot;https://docs.iplicit.com/dev/guide/identifiers/index.html\&quot;&gt;internal reference</a> of the contact

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

updateContact()

updateContact($idOrIntRef, $contactUpdate)

Update a contact

Example

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



$apiInstance = new SynergiTech\Iplicit\Api\ContactApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$idOrIntRef = 'idOrIntRef_example'; // string | Id or <a href=\"https://docs.iplicit.com/dev/guide/identifiers/index.html\">internal reference</a> of the contact
$contactUpdate = new \SynergiTech\Iplicit\Model\ContactUpdate(); // \SynergiTech\Iplicit\Model\ContactUpdate |

try {
    $apiInstance->updateContact($idOrIntRef, $contactUpdate);
} catch (Exception $e) {
    echo 'Exception when calling ContactApi->updateContact: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
idOrIntRef string Id or <a href=&quot;https://docs.iplicit.com/dev/guide/identifiers/index.html\&quot;&gt;internal reference</a> of the contact
contactUpdate \SynergiTech\Iplicit\Model\ContactUpdate [optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

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