AkeneoPresales\DescrbAPI\UsersApi

All URIs are relative to https://app.descrb.com.

Method	HTTP request	Description
changeUserLanguageApiV1UsersLanguagePatch()	PATCH /api/v1/users/language	Change User Language
createTrialSubApiV1UsersGetTrialPatch()	PATCH /api/v1/users/get-trial	Create Trial Sub
createUserApiV1UsersCreatePost()	POST /api/v1/users/create	Create User
createUserProfileApiV1UsersPost()	POST /api/v1/users/	Create User Profile
endActiveTrialApiV1UsersEndCurrentTrialPatch()	PATCH /api/v1/users/end-current-trial	End Active Trial
generateReportApiV1UsersReportGet()	GET /api/v1/users/report	Generate Report
markTrialNotificationAsSeenApiV1UsersNotificationAboutExpirePost()	POST /api/v1/users/notification-about-expire	Mark Trial Notification As Seen
patchUserApiV1UsersPatch()	PATCH /api/v1/users/	Patch User
readAllUsersApiV1UsersAllGet()	GET /api/v1/users/all	Read All Users
readUserApiV1UsersGet()	GET /api/v1/users/	Read User
readUserApiV1UsersPaymentsInfoGet()	GET /api/v1/users/payments-info	Read User
readUserDescriptionsApiV1UsersUserIdDescriptionsGet()	GET /api/v1/users/{user_id}/descriptions	Read User Descriptions
readUserNotReviewedDescriptionsApiV1UsersUserIdNotReviewedDescriptionsGet()	GET /api/v1/users/{user_id}/not-reviewed-descriptions	Read User Not Reviewed Descriptions
readUserNotSeenDescriptionsApiV1UsersUserIdNotSeenDescriptionsGet()	GET /api/v1/users/{user_id}/not-seen-descriptions	Read User Not Seen Descriptions
requestNewTotpApiV1UsersNewTotpPost()	POST /api/v1/users/new-totp	Request New Totp
testEndpointApiV1UsersTesterGet()	GET /api/v1/users/tester	Test Endpoint
toggleStateApiV1UsersToggleStatePost()	POST /api/v1/users/toggle-state	Toggle State
updateUserApiV1UsersPut()	PUT /api/v1/users/	Update User
validateEmailApiV1UsersValidateEmailPost()	POST /api/v1/users/validate-email	Validate Email

`changeUserLanguageApiV1UsersLanguagePatch()`

changeUserLanguageApiV1UsersLanguagePatch($language): \AkeneoPresales\DescrbAPI\Model\User

Change User Language

Example

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


// Configure OAuth2 access token for authorization: OAuth2PasswordBearer
$config = AkeneoPresales\DescrbAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new AkeneoPresales\DescrbAPI\Api\UsersApi(
    // 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
);
$language = 'language_example'; // string

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

Parameters

Name	Type	Description	Notes
language	string

Return type

\AkeneoPresales\DescrbAPI\Model\User

Authorization

OAuth2PasswordBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`createTrialSubApiV1UsersGetTrialPatch()`

createTrialSubApiV1UsersGetTrialPatch($pro): mixed

Create Trial Sub

Example

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


// Configure OAuth2 access token for authorization: OAuth2PasswordBearer
$config = AkeneoPresales\DescrbAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new AkeneoPresales\DescrbAPI\Api\UsersApi(
    // 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
);
$pro = True; // bool

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

Parameters

Name	Type	Description	Notes
pro	bool

Return type

mixed

Authorization

OAuth2PasswordBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`createUserApiV1UsersCreatePost()`

createUserApiV1UsersCreatePost($user_create): \AkeneoPresales\DescrbAPI\Model\User

Create User

Create new user (moderator function).

Example

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


// Configure OAuth2 access token for authorization: OAuth2PasswordBearer
$config = AkeneoPresales\DescrbAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new AkeneoPresales\DescrbAPI\Api\UsersApi(
    // 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
);
$user_create = new \AkeneoPresales\DescrbAPI\Model\UserCreate(); // \AkeneoPresales\DescrbAPI\Model\UserCreate

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

Parameters

Name	Type	Description	Notes
user_create	\AkeneoPresales\DescrbAPI\Model\UserCreate

Return type

\AkeneoPresales\DescrbAPI\Model\User

Authorization

OAuth2PasswordBearer

HTTP request headers

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

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

`createUserProfileApiV1UsersPost()`

createUserProfileApiV1UsersPost($body_create_user_profile_api_v1_users_post): \AkeneoPresales\DescrbAPI\Model\User

Create User Profile

Create new user without the need to be logged in.

Example

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



$apiInstance = new AkeneoPresales\DescrbAPI\Api\UsersApi(
    // 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()
);
$body_create_user_profile_api_v1_users_post = new \AkeneoPresales\DescrbAPI\Model\BodyCreateUserProfileApiV1UsersPost(); // \AkeneoPresales\DescrbAPI\Model\BodyCreateUserProfileApiV1UsersPost

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

Parameters

Name	Type	Description	Notes
body_create_user_profile_api_v1_users_post	\AkeneoPresales\DescrbAPI\Model\BodyCreateUserProfileApiV1UsersPost

Return type

\AkeneoPresales\DescrbAPI\Model\User

Authorization

No authorization required

HTTP request headers

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

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

`endActiveTrialApiV1UsersEndCurrentTrialPatch()`

endActiveTrialApiV1UsersEndCurrentTrialPatch(): mixed

End Active Trial

Example

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


// Configure OAuth2 access token for authorization: OAuth2PasswordBearer
$config = AkeneoPresales\DescrbAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new AkeneoPresales\DescrbAPI\Api\UsersApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

mixed

Authorization

OAuth2PasswordBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`generateReportApiV1UsersReportGet()`

generateReportApiV1UsersReportGet(): mixed

Generate Report

Example

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


// Configure OAuth2 access token for authorization: OAuth2PasswordBearer
$config = AkeneoPresales\DescrbAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new AkeneoPresales\DescrbAPI\Api\UsersApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

mixed

Authorization

OAuth2PasswordBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`markTrialNotificationAsSeenApiV1UsersNotificationAboutExpirePost()`

markTrialNotificationAsSeenApiV1UsersNotificationAboutExpirePost(): mixed

Mark Trial Notification As Seen

Example

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


// Configure OAuth2 access token for authorization: OAuth2PasswordBearer
$config = AkeneoPresales\DescrbAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new AkeneoPresales\DescrbAPI\Api\UsersApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

mixed

Authorization

OAuth2PasswordBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`patchUserApiV1UsersPatch()`

patchUserApiV1UsersPatch($user_in_db): \AkeneoPresales\DescrbAPI\Model\User

Patch User

Patch user.

Example

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


// Configure OAuth2 access token for authorization: OAuth2PasswordBearer
$config = AkeneoPresales\DescrbAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new AkeneoPresales\DescrbAPI\Api\UsersApi(
    // 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
);
$user_in_db = new \AkeneoPresales\DescrbAPI\Model\UserInDB(); // \AkeneoPresales\DescrbAPI\Model\UserInDB

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

Parameters

Name	Type	Description	Notes
user_in_db	\AkeneoPresales\DescrbAPI\Model\UserInDB

Return type

\AkeneoPresales\DescrbAPI\Model\User

Authorization

OAuth2PasswordBearer

HTTP request headers

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

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

`readAllUsersApiV1UsersAllGet()`

readAllUsersApiV1UsersAllGet($id, $full_name__ilike, $email__ilike, $is_active, $order_by, $limit, $offset): \AkeneoPresales\DescrbAPI\Model\LimitOffsetPageUser

Read All Users

Retrieve all current users.

Example

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


// Configure OAuth2 access token for authorization: OAuth2PasswordBearer
$config = AkeneoPresales\DescrbAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new AkeneoPresales\DescrbAPI\Api\UsersApi(
    // 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
$full_name__ilike = 'full_name__ilike_example'; // string
$email__ilike = 'email__ilike_example'; // string
$is_active = True; // bool
$order_by = 'full_name,email,is_active,is_superuser,count_descriptions,user_type'; // string
$limit = 50; // int
$offset = 0; // int

try {
    $result = $apiInstance->readAllUsersApiV1UsersAllGet($id, $full_name__ilike, $email__ilike, $is_active, $order_by, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->readAllUsersApiV1UsersAllGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Notes
id	string	[optional]
full_name__ilike	string	[optional]
email__ilike	string	[optional]
is_active	bool	[optional]
order_by	string	[optional] [default to 'full_name,email,is_active,is_superuser,count_descriptions,user_type']
limit	int	[optional] [default to 50]
offset	int	[optional] [default to 0]

Return type

\AkeneoPresales\DescrbAPI\Model\LimitOffsetPageUser

Authorization

OAuth2PasswordBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`readUserApiV1UsersGet()`

readUserApiV1UsersGet(): \AkeneoPresales\DescrbAPI\Model\User

Read User

Get current user.

Example

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


// Configure OAuth2 access token for authorization: OAuth2PasswordBearer
$config = AkeneoPresales\DescrbAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new AkeneoPresales\DescrbAPI\Api\UsersApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

\AkeneoPresales\DescrbAPI\Model\User

Authorization

OAuth2PasswordBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`readUserApiV1UsersPaymentsInfoGet()`

readUserApiV1UsersPaymentsInfoGet(): mixed

Read User

Get current user.

Example

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


// Configure OAuth2 access token for authorization: OAuth2PasswordBearer
$config = AkeneoPresales\DescrbAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new AkeneoPresales\DescrbAPI\Api\UsersApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

mixed

Authorization

OAuth2PasswordBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`readUserDescriptionsApiV1UsersUserIdDescriptionsGet()`

readUserDescriptionsApiV1UsersUserIdDescriptionsGet($user_id, $score, $name__ilike, $brand_name__ilike, $order_by, $limit, $offset): \AkeneoPresales\DescrbAPI\Model\LimitOffsetPageProductDescription

Read User Descriptions

Retrieve Descriptions for Given users.

Example

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


// Configure OAuth2 access token for authorization: OAuth2PasswordBearer
$config = AkeneoPresales\DescrbAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new AkeneoPresales\DescrbAPI\Api\UsersApi(
    // 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
);
$user_id = 'user_id_example'; // string
$score = 56; // int
$name__ilike = 'name__ilike_example'; // string
$brand_name__ilike = 'brand_name__ilike_example'; // string
$order_by = 'score,name,brand_name,created_at,brand_description_bool,product_history_description_bool,technologies_bool'; // string
$limit = 50; // int
$offset = 0; // int

try {
    $result = $apiInstance->readUserDescriptionsApiV1UsersUserIdDescriptionsGet($user_id, $score, $name__ilike, $brand_name__ilike, $order_by, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->readUserDescriptionsApiV1UsersUserIdDescriptionsGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Notes
user_id	string
score	int	[optional]
name__ilike	string	[optional]
brand_name__ilike	string	[optional]
order_by	string	[optional] [default to 'score,name,brand_name,created_at,brand_description_bool,product_history_description_bool,technologies_bool']
limit	int	[optional] [default to 50]
offset	int	[optional] [default to 0]

Return type

\AkeneoPresales\DescrbAPI\Model\LimitOffsetPageProductDescription

Authorization

OAuth2PasswordBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`readUserNotReviewedDescriptionsApiV1UsersUserIdNotReviewedDescriptionsGet()`

readUserNotReviewedDescriptionsApiV1UsersUserIdNotReviewedDescriptionsGet($user_id, $limit, $offset): \AkeneoPresales\DescrbAPI\Model\LimitOffsetPageProductDescriptionList

Read User Not Reviewed Descriptions

Retrieve Not Reviewed Descriptions for Given users.

Example

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


// Configure OAuth2 access token for authorization: OAuth2PasswordBearer
$config = AkeneoPresales\DescrbAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new AkeneoPresales\DescrbAPI\Api\UsersApi(
    // 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
);
$user_id = 'user_id_example'; // string
$limit = 50; // int
$offset = 0; // int

try {
    $result = $apiInstance->readUserNotReviewedDescriptionsApiV1UsersUserIdNotReviewedDescriptionsGet($user_id, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->readUserNotReviewedDescriptionsApiV1UsersUserIdNotReviewedDescriptionsGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Notes
user_id	string
limit	int	[optional] [default to 50]
offset	int	[optional] [default to 0]

Return type

\AkeneoPresales\DescrbAPI\Model\LimitOffsetPageProductDescriptionList

Authorization

OAuth2PasswordBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`readUserNotSeenDescriptionsApiV1UsersUserIdNotSeenDescriptionsGet()`

readUserNotSeenDescriptionsApiV1UsersUserIdNotSeenDescriptionsGet($user_id, $limit, $offset): \AkeneoPresales\DescrbAPI\Model\LimitOffsetPageProductDescriptionList

Read User Not Seen Descriptions

Retrieve Not Reviewed Descriptions for Given users.

Example

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


// Configure OAuth2 access token for authorization: OAuth2PasswordBearer
$config = AkeneoPresales\DescrbAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new AkeneoPresales\DescrbAPI\Api\UsersApi(
    // 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
);
$user_id = 'user_id_example'; // string
$limit = 50; // int
$offset = 0; // int

try {
    $result = $apiInstance->readUserNotSeenDescriptionsApiV1UsersUserIdNotSeenDescriptionsGet($user_id, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->readUserNotSeenDescriptionsApiV1UsersUserIdNotSeenDescriptionsGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Notes
user_id	string
limit	int	[optional] [default to 50]
offset	int	[optional] [default to 0]

Return type

\AkeneoPresales\DescrbAPI\Model\LimitOffsetPageProductDescriptionList

Authorization

OAuth2PasswordBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`requestNewTotpApiV1UsersNewTotpPost()`

requestNewTotpApiV1UsersNewTotpPost(): \AkeneoPresales\DescrbAPI\Model\NewTOTP

Request New Totp

Request new keys to enable TOTP on the user account.

Example

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


// Configure OAuth2 access token for authorization: OAuth2PasswordBearer
$config = AkeneoPresales\DescrbAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new AkeneoPresales\DescrbAPI\Api\UsersApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

\AkeneoPresales\DescrbAPI\Model\NewTOTP

Authorization

OAuth2PasswordBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`testEndpointApiV1UsersTesterGet()`

testEndpointApiV1UsersTesterGet(): \AkeneoPresales\DescrbAPI\Model\Msg

Test Endpoint

Test current endpoint.

Example

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



$apiInstance = new AkeneoPresales\DescrbAPI\Api\UsersApi(
    // 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()
);

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

Parameters

This endpoint does not need any parameter.

Return type

\AkeneoPresales\DescrbAPI\Model\Msg

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`toggleStateApiV1UsersToggleStatePost()`

toggleStateApiV1UsersToggleStatePost($user_update): \AkeneoPresales\DescrbAPI\Model\Msg

Toggle State

Toggle user state (moderator function)

Example

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


// Configure OAuth2 access token for authorization: OAuth2PasswordBearer
$config = AkeneoPresales\DescrbAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new AkeneoPresales\DescrbAPI\Api\UsersApi(
    // 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
);
$user_update = new \AkeneoPresales\DescrbAPI\Model\UserUpdate(); // \AkeneoPresales\DescrbAPI\Model\UserUpdate

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

Parameters

Name	Type	Description	Notes
user_update	\AkeneoPresales\DescrbAPI\Model\UserUpdate

Return type

\AkeneoPresales\DescrbAPI\Model\Msg

Authorization

OAuth2PasswordBearer

HTTP request headers

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

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

`updateUserApiV1UsersPut()`

updateUserApiV1UsersPut($marketing_agreement, $terms_agreement, $profile_picture, $original, $password, $full_name, $email): \AkeneoPresales\DescrbAPI\Model\User

Update User

Update user.

Example

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


// Configure OAuth2 access token for authorization: OAuth2PasswordBearer
$config = AkeneoPresales\DescrbAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new AkeneoPresales\DescrbAPI\Api\UsersApi(
    // 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
);
$marketing_agreement = True; // bool | Marketing agreement
$terms_agreement = True; // bool | Terms agreement
$profile_picture = new \AkeneoPresales\DescrbAPI\Model\AnyOfFileString(); // AnyOfFileString | Profile picture
$original = ''; // string | Original password
$password = 'password_example'; // string | New password
$full_name = 'full_name_example'; // string | Full user name
$email = 'email_example'; // string | User email

try {
    $result = $apiInstance->updateUserApiV1UsersPut($marketing_agreement, $terms_agreement, $profile_picture, $original, $password, $full_name, $email);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->updateUserApiV1UsersPut: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
marketing_agreement	bool	Marketing agreement
terms_agreement	bool	Terms agreement
profile_picture	AnyOfFileString	Profile picture	[optional]
original	string	Original password	[optional] [default to '']
password	string	New password	[optional]
full_name	string	Full user name	[optional]
email	string	User email	[optional]

Return type

\AkeneoPresales\DescrbAPI\Model\User

Authorization

OAuth2PasswordBearer

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

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

`validateEmailApiV1UsersValidateEmailPost()`

validateEmailApiV1UsersValidateEmailPost($body): \AkeneoPresales\DescrbAPI\Model\Msg

Validate Email

Reset password

Example

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


// Configure OAuth2 access token for authorization: OAuth2PasswordBearer
$config = AkeneoPresales\DescrbAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new AkeneoPresales\DescrbAPI\Api\UsersApi(
    // 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
);
$body = array('key' => new \stdClass); // object

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

Parameters

Name	Type	Description	Notes
body	object

Return type

\AkeneoPresales\DescrbAPI\Model\Msg

Authorization

OAuth2PasswordBearer

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

UsersApi.md

Latest commit

History

UsersApi.md

File metadata and controls

AkeneoPresales\DescrbAPI\UsersApi

changeUserLanguageApiV1UsersLanguagePatch()

Example

Parameters

Return type

Authorization

HTTP request headers

createTrialSubApiV1UsersGetTrialPatch()

Example

Parameters

Return type

Authorization

HTTP request headers

createUserApiV1UsersCreatePost()

Example

Parameters

Return type

Authorization

HTTP request headers

createUserProfileApiV1UsersPost()

Example

Parameters

Return type

Authorization

HTTP request headers

endActiveTrialApiV1UsersEndCurrentTrialPatch()

Example

Parameters

Return type

Authorization

HTTP request headers

generateReportApiV1UsersReportGet()

Example

Parameters

Return type

Authorization

HTTP request headers

markTrialNotificationAsSeenApiV1UsersNotificationAboutExpirePost()

Example

Parameters

Return type

Authorization

HTTP request headers

patchUserApiV1UsersPatch()

Example

Parameters

Return type

Authorization

HTTP request headers

readAllUsersApiV1UsersAllGet()

Example

Parameters

Return type

Authorization

HTTP request headers

readUserApiV1UsersGet()

Example

Parameters

Return type

Authorization

HTTP request headers

readUserApiV1UsersPaymentsInfoGet()

Example

Parameters

Return type

Authorization

HTTP request headers

readUserDescriptionsApiV1UsersUserIdDescriptionsGet()

Example

Parameters

Return type

Authorization

HTTP request headers

readUserNotReviewedDescriptionsApiV1UsersUserIdNotReviewedDescriptionsGet()

`changeUserLanguageApiV1UsersLanguagePatch()`

`createTrialSubApiV1UsersGetTrialPatch()`

`createUserApiV1UsersCreatePost()`

`createUserProfileApiV1UsersPost()`

`endActiveTrialApiV1UsersEndCurrentTrialPatch()`

`generateReportApiV1UsersReportGet()`

`markTrialNotificationAsSeenApiV1UsersNotificationAboutExpirePost()`

`patchUserApiV1UsersPatch()`

`readAllUsersApiV1UsersAllGet()`

`readUserApiV1UsersGet()`

`readUserApiV1UsersPaymentsInfoGet()`

`readUserDescriptionsApiV1UsersUserIdDescriptionsGet()`

`readUserNotReviewedDescriptionsApiV1UsersUserIdNotReviewedDescriptionsGet()`

`readUserNotSeenDescriptionsApiV1UsersUserIdNotSeenDescriptionsGet()`

`requestNewTotpApiV1UsersNewTotpPost()`

`testEndpointApiV1UsersTesterGet()`

`toggleStateApiV1UsersToggleStatePost()`

`updateUserApiV1UsersPut()`

`validateEmailApiV1UsersValidateEmailPost()`