Skip to content

Latest commit

 

History

History
230 lines (151 loc) · 6.12 KB

AccountServiceApi.md

File metadata and controls

230 lines (151 loc) · 6.12 KB

OpenAPI\Client\AccountServiceApi

All URIs are relative to http://api.madana.io/rest.

Method HTTP request Description
activateUser() GET /account/activation/{token}
createPasswordReset() POST /account/password Sends an Password reset mail to the given MailAddress.
requestVerificationMail() GET /account/verifymail Used to request a new activation-mail for the user.
updatePassword() PUT /account/password Receives the Password reset and tries to set the provided password for the user.

activateUser()

activateUser($token): \SplFileObject

Example

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



$apiInstance = new OpenAPI\Client\Api\AccountServiceApi(
    // 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()
);
$token = 'token_example'; // string

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

Parameters

Name Type Description Notes
token string

Return type

\SplFileObject

Authorization

No authorization required

HTTP request headers

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

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

createPasswordReset()

createPasswordReset($body): \SplFileObject

Sends an Password reset mail to the given MailAddress.

Sends an Password reset mail to the given MailAddress

Example

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



$apiInstance = new OpenAPI\Client\Api\AccountServiceApi(
    // 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 = new \OpenAPI\Client\Model\JsonMDNMailAddress(); // \OpenAPI\Client\Model\JsonMDNMailAddress | - the MaiAddress under which the user has signed up

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

Parameters

Name Type Description Notes
body \OpenAPI\Client\Model\JsonMDNMailAddress - the MaiAddress under which the user has signed up [optional]

Return type

\SplFileObject

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/xml

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

requestVerificationMail()

requestVerificationMail(): map[string,object]

Used to request a new activation-mail for the user.

Used to request a new activation-mail for the user

Example

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



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

Parameters

This endpoint does not need any parameter.

Return type

map[string,object]

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]

updatePassword()

updatePassword($body): \SplFileObject

Receives the Password reset and tries to set the provided password for the user.

Receives the Password reset and tries to set the provided password for the user. The Password will only be set if a valid token is provided

Example

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



$apiInstance = new OpenAPI\Client\Api\AccountServiceApi(
    // 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 = new \OpenAPI\Client\Model\JsonMDNPasswordReset(); // \OpenAPI\Client\Model\JsonMDNPasswordReset | - the MDN_PasswordReset Object

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

Parameters

Name Type Description Notes
body \OpenAPI\Client\Model\JsonMDNPasswordReset - the MDN_PasswordReset Object [optional]

Return type

\SplFileObject

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/xml

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