Equisoft\SDK\EquisoftConnect\DatabasesApi

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

Method	HTTP request	Description
createChargebeeCustomer()	POST /crm/api/v1/databases/{databaseUuid}/chargebeeCustomer	Create a ChargeBee customer for the database
getDatabase()	GET /crm/api/v1/databases/{databaseUuid}	Get a database
getUser()	GET /crm/api/v1/databases/{databaseUuid}/users/{userId}	Get a database's user
listDatabases()	GET /crm/api/v1/databases	List all databases
listUsers()	GET /crm/api/v1/databases/{databaseUuid}/users	List database's users
setDatabaseDistributor()	PUT /crm/api/v1/databases/{databaseUuid}/distributor	Set the database's distributor
unsetDatabaseDistributor()	DELETE /crm/api/v1/databases/{databaseUuid}/distributor	Unset the database's distributor
updateState()	PUT /crm/api/v1/databases/{databaseUuid}/state	Update a database's state
updateUser()	PATCH /crm/api/v1/databases/{databaseUuid}/users/{userId}	Update a database's user

`createChargebeeCustomer()`

createChargebeeCustomer($databaseUuid): \Equisoft\SDK\EquisoftConnect\Model\DatabaseDatabaseChargebeeCustomerCreatedResponse

Create a ChargeBee customer for the database

Example

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


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\DatabasesApi(
    // 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
);
$databaseUuid = 'databaseUuid_example'; // string | Database unique identifier.

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

Parameters

Name	Type	Description	Notes
databaseUuid	string	Database unique identifier.

Return type

\Equisoft\SDK\EquisoftConnect\Model\DatabaseDatabaseChargebeeCustomerCreatedResponse

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`getDatabase()`

getDatabase($databaseUuid): \Equisoft\SDK\EquisoftConnect\Model\DatabasesDatabase

Get a database

Example

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


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\DatabasesApi(
    // 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
);
$databaseUuid = 'databaseUuid_example'; // string | Database unique identifier.

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

Parameters

Name	Type	Description	Notes
databaseUuid	string	Database unique identifier.

Return type

\Equisoft\SDK\EquisoftConnect\Model\DatabasesDatabase

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`getUser()`

getUser($databaseUuid, $userId): \Equisoft\SDK\EquisoftConnect\Model\UsersUser

Get a database's user

Example

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


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\DatabasesApi(
    // 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
);
$databaseUuid = 'databaseUuid_example'; // string | Database unique identifier.
$userId = 56; // int | User identifier.

try {
    $result = $apiInstance->getUser($databaseUuid, $userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DatabasesApi->getUser: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
databaseUuid	string	Database unique identifier.
userId	int	User identifier.

Return type

\Equisoft\SDK\EquisoftConnect\Model\UsersUser

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`listDatabases()`

listDatabases($organizationUuid, $databaseName): \Equisoft\SDK\EquisoftConnect\Model\DatabasesListDatabasesResponse

List all databases

Example

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


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\DatabasesApi(
    // 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
);
$organizationUuid = 'organizationUuid_example'; // string | Organization unique identifier.
$databaseName = 'databaseName_example'; // string | Database name.

try {
    $result = $apiInstance->listDatabases($organizationUuid, $databaseName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DatabasesApi->listDatabases: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
organizationUuid	string	Organization unique identifier.	[optional]
databaseName	string	Database name.	[optional]

Return type

\Equisoft\SDK\EquisoftConnect\Model\DatabasesListDatabasesResponse

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`listUsers()`

listUsers($databaseUuid): \Equisoft\SDK\EquisoftConnect\Model\UsersListUsersResponse

List database's users

Example

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


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\DatabasesApi(
    // 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
);
$databaseUuid = 'databaseUuid_example'; // string | Database unique identifier.

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

Parameters

Name	Type	Description	Notes
databaseUuid	string	Database unique identifier.

Return type

\Equisoft\SDK\EquisoftConnect\Model\UsersListUsersResponse

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`setDatabaseDistributor()`

setDatabaseDistributor($databaseUuid, $databaseSetDistributorPayload)

Set the database's distributor

Example

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


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\DatabasesApi(
    // 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
);
$databaseUuid = 'databaseUuid_example'; // string | Database unique identifier.
$databaseSetDistributorPayload = new \Equisoft\SDK\EquisoftConnect\Model\DatabaseSetDistributorPayload(); // \Equisoft\SDK\EquisoftConnect\Model\DatabaseSetDistributorPayload

try {
    $apiInstance->setDatabaseDistributor($databaseUuid, $databaseSetDistributorPayload);
} catch (Exception $e) {
    echo 'Exception when calling DatabasesApi->setDatabaseDistributor: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
databaseUuid	string	Database unique identifier.
databaseSetDistributorPayload	\Equisoft\SDK\EquisoftConnect\Model\DatabaseSetDistributorPayload

Return type

void (empty response body)

Authorization

OAuth2

HTTP request headers

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

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

`unsetDatabaseDistributor()`

unsetDatabaseDistributor($databaseUuid)

Unset the database's distributor

Example

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


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\DatabasesApi(
    // 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
);
$databaseUuid = 'databaseUuid_example'; // string | Database unique identifier.

try {
    $apiInstance->unsetDatabaseDistributor($databaseUuid);
} catch (Exception $e) {
    echo 'Exception when calling DatabasesApi->unsetDatabaseDistributor: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
databaseUuid	string	Database unique identifier.

Return type

void (empty response body)

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`updateState()`

updateState($databaseUuid, $databaseUpdateStatePayload)

Update a database's state

Example

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


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\DatabasesApi(
    // 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
);
$databaseUuid = 'databaseUuid_example'; // string | Database unique identifier.
$databaseUpdateStatePayload = new \Equisoft\SDK\EquisoftConnect\Model\DatabaseUpdateStatePayload(); // \Equisoft\SDK\EquisoftConnect\Model\DatabaseUpdateStatePayload

try {
    $apiInstance->updateState($databaseUuid, $databaseUpdateStatePayload);
} catch (Exception $e) {
    echo 'Exception when calling DatabasesApi->updateState: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
databaseUuid	string	Database unique identifier.
databaseUpdateStatePayload	\Equisoft\SDK\EquisoftConnect\Model\DatabaseUpdateStatePayload

Return type

void (empty response body)

Authorization

OAuth2

HTTP request headers

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

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

`updateUser()`

updateUser($databaseUuid, $userId, $usersUpdateUserPayload)

Update a database's user

Example

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


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\DatabasesApi(
    // 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
);
$databaseUuid = 'databaseUuid_example'; // string | Database unique identifier.
$userId = 56; // int | User identifier.
$usersUpdateUserPayload = new \Equisoft\SDK\EquisoftConnect\Model\UsersUpdateUserPayload(); // \Equisoft\SDK\EquisoftConnect\Model\UsersUpdateUserPayload

try {
    $apiInstance->updateUser($databaseUuid, $userId, $usersUpdateUserPayload);
} catch (Exception $e) {
    echo 'Exception when calling DatabasesApi->updateUser: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
databaseUuid	string	Database unique identifier.
userId	int	User identifier.
usersUpdateUserPayload	\Equisoft\SDK\EquisoftConnect\Model\UsersUpdateUserPayload

Return type

void (empty response body)

Authorization

OAuth2

HTTP request headers

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

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

Files

DatabasesApi.md

Latest commit

History

DatabasesApi.md

File metadata and controls

Equisoft\SDK\EquisoftConnect\DatabasesApi

createChargebeeCustomer()

Example

Parameters

Return type

Authorization

HTTP request headers

getDatabase()

Example

Parameters

Return type

Authorization

HTTP request headers

getUser()

Example

Parameters

Return type

Authorization

HTTP request headers

listDatabases()

Example

Parameters

Return type

Authorization

HTTP request headers

listUsers()

Example

Parameters

Return type

Authorization

HTTP request headers

setDatabaseDistributor()

Example

Parameters

Return type

Authorization

HTTP request headers

unsetDatabaseDistributor()

Example

Parameters

Return type

Authorization

HTTP request headers

updateState()

Example

Parameters

Return type

Authorization

HTTP request headers

updateUser()

Example

Parameters

Return type

Authorization

HTTP request headers

`createChargebeeCustomer()`

`getDatabase()`

`getUser()`

`listDatabases()`

`listUsers()`

`setDatabaseDistributor()`

`unsetDatabaseDistributor()`

`updateState()`

`updateUser()`