BusinessLogicServiceApi.md

Alfaview\BusinessLogicServiceApi

All URIs are relative to https://localhost

Method	HTTP request	Description
companyDestroy	POST /companies/destroy
companySignup	POST /companies/signup
createCompany	POST /companies/create
favoritesList	POST /favorites/list
favoritesUpdate	POST /favorites/update
inviteUsers	POST /inviteUsers
permissionGroupsList	POST /permissionGroups/list
permissionGroupsUpdate	POST /permissionGroups/update
streamTaskProgress	POST /streamTaskProgress

companyDestroy

\Alfaview\Model\BusinessLogicServiceCompanyDestroyReply companyDestroy($body)

Example

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

$apiInstance = new Alfaview\Api\BusinessLogicServiceApi(
    // 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\BusinessLogicServiceCompanyDestroyRequest(); // \Alfaview\Model\BusinessLogicServiceCompanyDestroyRequest | * CompanyDestroyRequest is used to completely destroy a company and all associated data via a gokju task.

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

Parameters

Name	Type	Description	Notes
body	\Alfaview\Model\BusinessLogicServiceCompanyDestroyRequest	* CompanyDestroyRequest is used to completely destroy a company and all associated data via a gokju task.

Return type

\Alfaview\Model\BusinessLogicServiceCompanyDestroyReply

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]

companySignup

\Alfaview\Model\BusinessLogicServiceCompanySignupReply companySignup($body)

Example

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

$apiInstance = new Alfaview\Api\BusinessLogicServiceApi(
    // 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\BusinessLogicServiceCompanySignupRequest(); // \Alfaview\Model\BusinessLogicServiceCompanySignupRequest | * A CompanySignupRequest is used for regular sign-ups. It can be called by anyone and does not require an access token.

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

Parameters

Name	Type	Description	Notes
body	\Alfaview\Model\BusinessLogicServiceCompanySignupRequest	* A CompanySignupRequest is used for regular sign-ups. It can be called by anyone and does not require an access token.

Return type

\Alfaview\Model\BusinessLogicServiceCompanySignupReply

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]

createCompany

\Alfaview\Model\BusinessLogicServiceCompanyCreateReply createCompany($body)

Example

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

$apiInstance = new Alfaview\Api\BusinessLogicServiceApi(
    // 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\BusinessLogicServiceCompanyCreateRequest(); // \Alfaview\Model\BusinessLogicServiceCompanyCreateRequest | * A CompanyCreateRequest is used internally via the admin web app to create a company with a user profile and a single room attached to it. It requires the COMPANY_ADMIN backend permission.

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

Parameters

Name	Type	Description	Notes
body	\Alfaview\Model\BusinessLogicServiceCompanyCreateRequest	* A CompanyCreateRequest is used internally via the admin web app to create a company with a user profile and a single room attached to it. It requires the COMPANY_ADMIN backend permission.

Return type

\Alfaview\Model\BusinessLogicServiceCompanyCreateReply

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]

favoritesList

\Alfaview\Model\BusinessLogicServiceFavoritesListReply favoritesList($body)

Example

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

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

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

Parameters

Name	Type	Description	Notes
body	\Alfaview\Model\BusinessLogicServiceFavoritesListRequest

Return type

\Alfaview\Model\BusinessLogicServiceFavoritesListReply

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]

favoritesUpdate

\Alfaview\Model\BusinessLogicServiceFavoritesUpdateReply favoritesUpdate($body)

Example

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

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

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

Parameters

Name	Type	Description	Notes
body	\Alfaview\Model\BusinessLogicServiceFavoritesUpdateRequest

Return type

\Alfaview\Model\BusinessLogicServiceFavoritesUpdateReply

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]

inviteUsers

\Alfaview\Model\BusinessLogicServiceInviteUsersReply inviteUsers($body)

Example

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

$apiInstance = new Alfaview\Api\BusinessLogicServiceApi(
    // 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\BusinessLogicServiceInviteUsersRequest(); // \Alfaview\Model\BusinessLogicServiceInviteUsersRequest | * Use InviteUsersRequest to invite a list of users and assign them their permissions.

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

Parameters

Name	Type	Description	Notes
body	\Alfaview\Model\BusinessLogicServiceInviteUsersRequest	* Use InviteUsersRequest to invite a list of users and assign them their permissions.

Return type

\Alfaview\Model\BusinessLogicServiceInviteUsersReply

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]

permissionGroupsList

\Alfaview\Model\BusinessLogicServiceCompanyPermissionGroupsListReply permissionGroupsList($body)

Example

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

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

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

Parameters

Name	Type	Description	Notes
body	\Alfaview\Model\BusinessLogicServiceCompanyPermissionGroupsListRequest

Return type

\Alfaview\Model\BusinessLogicServiceCompanyPermissionGroupsListReply

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]

permissionGroupsUpdate

\Alfaview\Model\BusinessLogicServiceCompanyPermissionGroupsUpdateReply permissionGroupsUpdate($body)

Example

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

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

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

Parameters

Name	Type	Description	Notes
body	\Alfaview\Model\BusinessLogicServiceCompanyPermissionGroupsUpdateRequest

Return type

\Alfaview\Model\BusinessLogicServiceCompanyPermissionGroupsUpdateReply

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\StreamResultOfBusinessLogicServiceTaskProgressReply streamTaskProgress($body)

Example

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

$apiInstance = new Alfaview\Api\BusinessLogicServiceApi(
    // 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\BusinessLogicServiceTaskProgressRequest(); // \Alfaview\Model\BusinessLogicServiceTaskProgressRequest | * Use TaskProgressRequest to request the progress report of a task by its ID.

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

Parameters

Name	Type	Description	Notes
body	\Alfaview\Model\BusinessLogicServiceTaskProgressRequest	* Use TaskProgressRequest to request the progress report of a task by its ID.

Return type

\Alfaview\Model\StreamResultOfBusinessLogicServiceTaskProgressReply

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]