OpenAPI\Client\SubscriptionsApi

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

Method	HTTP request	Description
subscriptionsGetDefaultPermissions()	GET /api/manage/v1/Subscriptions/{subscriptionId}/defaultPermissions	Get subscription's default permissions for new entities
subscriptionsGetMyPermissions()	GET /api/manage/v1/Subscriptions/{subId}/mypermissions	Get user's permissions for a subscription by id
subscriptionsGetPermissions()	GET /api/manage/v1/Subscriptions/{id}/permissions	Get permissions for a subscription by id
subscriptionsGetSubscription()	GET /api/manage/v1/Subscriptions/{id}	Returns the subscription by id
subscriptionsGetSubscriptions()	GET /api/manage/v1/Subscriptions	Returns a list of all subscriptions of current user
subscriptionsRenameSubscription()	PUT /api/manage/v1/Subscriptions/{subscriptionId}/rename	Rename subscription
subscriptionsUpdateDefaultPermissions()	PUT /api/manage/v1/Subscriptions/{subscriptionId}/defaultPermissions	Change subscription's default permissions for new entities
subscriptionsUpdateLocale()	PUT /api/manage/v1/Subscriptions/{subscriptionId}/Locale	Update subscription's default locale
subscriptionsUpdatePermissions()	POST /api/manage/v1/Subscriptions/{id}/permissions	Update permissions

`subscriptionsGetDefaultPermissions()`

subscriptionsGetDefaultPermissions($subscription_id): \OpenAPI\Client\cloud\fastreport\model\DefaultPermissionsVM

Get subscription's default permissions for new entities

Example

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


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\SubscriptionsApi(
    // 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
);
$subscription_id = 'subscription_id_example'; // string | id

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

Parameters

Name	Type	Description	Notes
subscription_id	string	id

Return type

\OpenAPI\Client\cloud\fastreport\model\DefaultPermissionsVM

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`subscriptionsGetMyPermissions()`

subscriptionsGetMyPermissions($sub_id): \OpenAPI\Client\cloud\fastreport\model\MyPermissionsVM

Get user's permissions for a subscription by id

Example

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


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\SubscriptionsApi(
    // 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
);
$sub_id = 'sub_id_example'; // string | subscription id

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

Parameters

Name	Type	Description	Notes
sub_id	string	subscription id

Return type

\OpenAPI\Client\cloud\fastreport\model\MyPermissionsVM

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`subscriptionsGetPermissions()`

subscriptionsGetPermissions($id): \OpenAPI\Client\cloud\fastreport\model\SubscriptionPermissionsVM

Get permissions for a subscription by id

Example

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


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\SubscriptionsApi(
    // 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 | 

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

Parameters

Name	Type	Description	Notes
id	string

Return type

\OpenAPI\Client\cloud\fastreport\model\SubscriptionPermissionsVM

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`subscriptionsGetSubscription()`

subscriptionsGetSubscription($id): \OpenAPI\Client\cloud\fastreport\model\SubscriptionVM

Returns the subscription by id

Example

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


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\SubscriptionsApi(
    // 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 | Identifier of subscription

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

Parameters

Name	Type	Description	Notes
id	string	Identifier of subscription

Return type

\OpenAPI\Client\cloud\fastreport\model\SubscriptionVM

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`subscriptionsGetSubscriptions()`

subscriptionsGetSubscriptions($skip, $take): \OpenAPI\Client\cloud\fastreport\model\SubscriptionsVM

Returns a list of all subscriptions of current user

Example

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


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\SubscriptionsApi(
    // 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
);
$skip = 0; // int | Variable for pagination, defautl value is 0
$take = 10; // int | Variable for pagination, default value is 10

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

Parameters

Name	Type	Description	Notes
skip	int	Variable for pagination, defautl value is 0	[optional] [default to 0]
take	int	Variable for pagination, default value is 10	[optional] [default to 10]

Return type

\OpenAPI\Client\cloud\fastreport\model\SubscriptionsVM

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`subscriptionsRenameSubscription()`

subscriptionsRenameSubscription($subscription_id, $rename_subscription_vm): \OpenAPI\Client\cloud\fastreport\model\SubscriptionVM

Rename subscription

Example

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


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\SubscriptionsApi(
    // 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
);
$subscription_id = 'subscription_id_example'; // string | id
$rename_subscription_vm = new \OpenAPI\Client\cloud\fastreport\model\RenameSubscriptionVM(); // \OpenAPI\Client\cloud\fastreport\model\RenameSubscriptionVM | rename VM

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

Parameters

Name	Type	Description	Notes
subscription_id	string	id
rename_subscription_vm	\OpenAPI\Client\cloud\fastreport\model\RenameSubscriptionVM	rename VM

Return type

\OpenAPI\Client\cloud\fastreport\model\SubscriptionVM

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: application/json, text/json, application/*+json
Accept: application/json

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

`subscriptionsUpdateDefaultPermissions()`

subscriptionsUpdateDefaultPermissions($subscription_id, $update_default_permissions_vm): \OpenAPI\Client\cloud\fastreport\model\DefaultPermissionsVM

Change subscription's default permissions for new entities

Example

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


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\SubscriptionsApi(
    // 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
);
$subscription_id = 'subscription_id_example'; // string | id
$update_default_permissions_vm = new \OpenAPI\Client\cloud\fastreport\model\UpdateDefaultPermissionsVM(); // \OpenAPI\Client\cloud\fastreport\model\UpdateDefaultPermissionsVM | update default permissions VM

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

Parameters

Name	Type	Description	Notes
subscription_id	string	id
update_default_permissions_vm	\OpenAPI\Client\cloud\fastreport\model\UpdateDefaultPermissionsVM	update default permissions VM

Return type

\OpenAPI\Client\cloud\fastreport\model\DefaultPermissionsVM

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: application/json, text/json, application/*+json
Accept: application/json

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

`subscriptionsUpdateLocale()`

subscriptionsUpdateLocale($subscription_id, $update_subscription_locale_vm): \OpenAPI\Client\cloud\fastreport\model\SubscriptionVM

Update subscription's default locale

Example

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


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\SubscriptionsApi(
    // 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
);
$subscription_id = 'subscription_id_example'; // string | id
$update_subscription_locale_vm = new \OpenAPI\Client\cloud\fastreport\model\UpdateSubscriptionLocaleVM(); // \OpenAPI\Client\cloud\fastreport\model\UpdateSubscriptionLocaleVM | update VM

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

Parameters

Name	Type	Description	Notes
subscription_id	string	id
update_subscription_locale_vm	\OpenAPI\Client\cloud\fastreport\model\UpdateSubscriptionLocaleVM	update VM

Return type

\OpenAPI\Client\cloud\fastreport\model\SubscriptionVM

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: application/json, text/json, application/*+json
Accept: application/json

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

`subscriptionsUpdatePermissions()`

subscriptionsUpdatePermissions($id, $update_subscription_permissions_vm)

Update permissions

Example

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


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\SubscriptionsApi(
    // 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 | 
$update_subscription_permissions_vm = new \OpenAPI\Client\cloud\fastreport\model\UpdateSubscriptionPermissionsVM(); // \OpenAPI\Client\cloud\fastreport\model\UpdateSubscriptionPermissionsVM | 

try {
    $apiInstance->subscriptionsUpdatePermissions($id, $update_subscription_permissions_vm);
} catch (Exception $e) {
    echo 'Exception when calling SubscriptionsApi->subscriptionsUpdatePermissions: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string
update_subscription_permissions_vm	\OpenAPI\Client\cloud\fastreport\model\UpdateSubscriptionPermissionsVM		[optional]

Return type

void (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: application/json, text/json, application/*+json
Accept: application/json

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

Files

SubscriptionsApi.md

Latest commit

History

SubscriptionsApi.md

File metadata and controls

OpenAPI\Client\SubscriptionsApi

subscriptionsGetDefaultPermissions()

Example

Parameters

Return type

Authorization

HTTP request headers

subscriptionsGetMyPermissions()

Example

Parameters

Return type

Authorization

HTTP request headers

subscriptionsGetPermissions()

Example

Parameters

Return type

Authorization

HTTP request headers

subscriptionsGetSubscription()

Example

Parameters

Return type

Authorization

HTTP request headers

subscriptionsGetSubscriptions()

Example

Parameters

Return type

Authorization

HTTP request headers

subscriptionsRenameSubscription()

Example

Parameters

Return type

Authorization

HTTP request headers

subscriptionsUpdateDefaultPermissions()

Example

Parameters

Return type

Authorization

HTTP request headers

subscriptionsUpdateLocale()

Example

Parameters

Return type

Authorization

HTTP request headers

subscriptionsUpdatePermissions()

Example

Parameters

Return type

Authorization

HTTP request headers

`subscriptionsGetDefaultPermissions()`

`subscriptionsGetMyPermissions()`

`subscriptionsGetPermissions()`

`subscriptionsGetSubscription()`

`subscriptionsGetSubscriptions()`

`subscriptionsRenameSubscription()`

`subscriptionsUpdateDefaultPermissions()`

`subscriptionsUpdateLocale()`

`subscriptionsUpdatePermissions()`