Skip to content

Latest commit

 

History

History
632 lines (434 loc) · 19.9 KB

GuestServiceApi.md

File metadata and controls

632 lines (434 loc) · 19.9 KB

Alfaview\GuestServiceApi

All URIs are relative to https://localhost

Method HTTP request Description
authenticate POST /authenticate
createGroupLinks POST /createGroupLinks
createGuestLinks POST /createGuestLinks
deleteLink POST /deleteLink
getGroupLink POST /getGroupLink
getGuestLink POST /getGuestLink
getLink POST /getLink
listGroupLinks POST /listGroupLinks
listGuestLinks POST /listGuestLinks
resendGuestLinkEmail POST /resendGuestLinkEmail
streamTaskProgress POST /streamTaskProgress streamTaskProgress is deprecated: services may return status NOT_IMPLEMENTED at some point in the future.
updateGroupLink POST /updateGroupLink
updateGuestLink POST /updateGuestLink

authenticate

\Alfaview\Model\GuestServiceV2AuthenticateReply authenticate($body)

Example

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

$apiInstance = new Alfaview\Api\GuestServiceApi(
    // 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 \Alfaview\Model\GuestServiceV2AuthenticateRequest(); // \Alfaview\Model\GuestServiceV2AuthenticateRequest | 

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

Parameters

Name Type Description Notes
body \Alfaview\Model\GuestServiceV2AuthenticateRequest

Return type

\Alfaview\Model\GuestServiceV2AuthenticateReply

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]

createGroupLinks

\Alfaview\Model\GuestServiceV2CreateGroupLinksReply createGroupLinks($body)

Example

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

$apiInstance = new Alfaview\Api\GuestServiceApi(
    // 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 \Alfaview\Model\GuestServiceV2CreateGroupLinksRequest(); // \Alfaview\Model\GuestServiceV2CreateGroupLinksRequest | 

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

Parameters

Name Type Description Notes
body \Alfaview\Model\GuestServiceV2CreateGroupLinksRequest

Return type

\Alfaview\Model\GuestServiceV2CreateGroupLinksReply

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]

createGuestLinks

\Alfaview\Model\GuestServiceV2CreateGuestLinksReply createGuestLinks($body)

Example

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

$apiInstance = new Alfaview\Api\GuestServiceApi(
    // 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 \Alfaview\Model\GuestServiceV2CreateGuestLinksRequest(); // \Alfaview\Model\GuestServiceV2CreateGuestLinksRequest | 

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

Parameters

Name Type Description Notes
body \Alfaview\Model\GuestServiceV2CreateGuestLinksRequest

Return type

\Alfaview\Model\GuestServiceV2CreateGuestLinksReply

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]

deleteLink

\Alfaview\Model\GuestServiceV2DeleteLinkReply deleteLink($body)

Example

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

$apiInstance = new Alfaview\Api\GuestServiceApi(
    // 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 \Alfaview\Model\GuestServiceV2DeleteLinkRequest(); // \Alfaview\Model\GuestServiceV2DeleteLinkRequest | 

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

Parameters

Name Type Description Notes
body \Alfaview\Model\GuestServiceV2DeleteLinkRequest

Return type

\Alfaview\Model\GuestServiceV2DeleteLinkReply

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]

getGroupLink

\Alfaview\Model\GuestServiceV2GetGroupLinkReply getGroupLink($body)

Example

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

$apiInstance = new Alfaview\Api\GuestServiceApi(
    // 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 \Alfaview\Model\GuestServiceV2GetGroupLinkRequest(); // \Alfaview\Model\GuestServiceV2GetGroupLinkRequest | 

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

Parameters

Name Type Description Notes
body \Alfaview\Model\GuestServiceV2GetGroupLinkRequest

Return type

\Alfaview\Model\GuestServiceV2GetGroupLinkReply

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]

getGuestLink

\Alfaview\Model\GuestServiceV2GetGuestLinkReply getGuestLink($body)

Example

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

$apiInstance = new Alfaview\Api\GuestServiceApi(
    // 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 \Alfaview\Model\GuestServiceV2GetGuestLinkRequest(); // \Alfaview\Model\GuestServiceV2GetGuestLinkRequest | 

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

Parameters

Name Type Description Notes
body \Alfaview\Model\GuestServiceV2GetGuestLinkRequest

Return type

\Alfaview\Model\GuestServiceV2GetGuestLinkReply

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]

getLink

\Alfaview\Model\GuestServiceV2GetLinkReply getLink($body)

Example

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

$apiInstance = new Alfaview\Api\GuestServiceApi(
    // 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 \Alfaview\Model\GuestServiceV2GetLinkRequest(); // \Alfaview\Model\GuestServiceV2GetLinkRequest | 

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

Parameters

Name Type Description Notes
body \Alfaview\Model\GuestServiceV2GetLinkRequest

Return type

\Alfaview\Model\GuestServiceV2GetLinkReply

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]

listGroupLinks

\Alfaview\Model\GuestServiceV2ListGroupLinksReply listGroupLinks($body)

Example

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

$apiInstance = new Alfaview\Api\GuestServiceApi(
    // 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 \Alfaview\Model\GuestServiceV2ListGroupLinksRequest(); // \Alfaview\Model\GuestServiceV2ListGroupLinksRequest | 

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

Parameters

Name Type Description Notes
body \Alfaview\Model\GuestServiceV2ListGroupLinksRequest

Return type

\Alfaview\Model\GuestServiceV2ListGroupLinksReply

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]

listGuestLinks

\Alfaview\Model\GuestServiceV2ListGuestLinksReply listGuestLinks($body)

Example

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

$apiInstance = new Alfaview\Api\GuestServiceApi(
    // 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 \Alfaview\Model\GuestServiceV2ListGuestLinksRequest(); // \Alfaview\Model\GuestServiceV2ListGuestLinksRequest | 

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

Parameters

Name Type Description Notes
body \Alfaview\Model\GuestServiceV2ListGuestLinksRequest

Return type

\Alfaview\Model\GuestServiceV2ListGuestLinksReply

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]

resendGuestLinkEmail

\Alfaview\Model\GuestServiceV2ResendGuestLinkEmailReply resendGuestLinkEmail($body)

Example

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

$apiInstance = new Alfaview\Api\GuestServiceApi(
    // 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 \Alfaview\Model\GuestServiceV2ResendGuestLinkEmailRequest(); // \Alfaview\Model\GuestServiceV2ResendGuestLinkEmailRequest | 

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

Parameters

Name Type Description Notes
body \Alfaview\Model\GuestServiceV2ResendGuestLinkEmailRequest

Return type

\Alfaview\Model\GuestServiceV2ResendGuestLinkEmailReply

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]

streamTaskProgress

\Alfaview\Model\StreamResultOfGuestServiceV2TaskProgressReply streamTaskProgress($body)

streamTaskProgress is deprecated: services may return status NOT_IMPLEMENTED at some point in the future.

Example

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

$apiInstance = new Alfaview\Api\GuestServiceApi(
    // 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 \Alfaview\Model\GuestServiceV2TaskProgressRequest(); // \Alfaview\Model\GuestServiceV2TaskProgressRequest | 

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

Parameters

Name Type Description Notes
body \Alfaview\Model\GuestServiceV2TaskProgressRequest

Return type

\Alfaview\Model\StreamResultOfGuestServiceV2TaskProgressReply

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]

updateGroupLink

\Alfaview\Model\GuestServiceV2UpdateGroupLinkReply updateGroupLink($body)

Example

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

$apiInstance = new Alfaview\Api\GuestServiceApi(
    // 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 \Alfaview\Model\GuestServiceV2UpdateGroupLinkRequest(); // \Alfaview\Model\GuestServiceV2UpdateGroupLinkRequest | 

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

Parameters

Name Type Description Notes
body \Alfaview\Model\GuestServiceV2UpdateGroupLinkRequest

Return type

\Alfaview\Model\GuestServiceV2UpdateGroupLinkReply

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]

updateGuestLink

\Alfaview\Model\GuestServiceV2UpdateGuestLinkReply updateGuestLink($body)

Example

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

$apiInstance = new Alfaview\Api\GuestServiceApi(
    // 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 \Alfaview\Model\GuestServiceV2UpdateGuestLinkRequest(); // \Alfaview\Model\GuestServiceV2UpdateGuestLinkRequest | 

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

Parameters

Name Type Description Notes
body \Alfaview\Model\GuestServiceV2UpdateGuestLinkRequest

Return type

\Alfaview\Model\GuestServiceV2UpdateGuestLinkReply

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]