Skip to content

Latest commit

 

History

History
332 lines (229 loc) · 10.7 KB

SubscriptionUsersApi.md

File metadata and controls

332 lines (229 loc) · 10.7 KB
Raw

OpenAPI\Client\SubscriptionUsersApi

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

Method HTTP request Description
subscriptionUsersAddUser() PUT /api/manage/v1/Subscriptions/{subscriptionId}/users/{userId} Add a user to the subscription, the added users will be displayed in the list of users of the subscription, and these users will also have an active subscription.
subscriptionUsersCountUsersAsync() GET /api/manage/v1/Subscriptions/{subscriptionId}/UsersCount Returns a number of users in subscription
subscriptionUsersGetUsers() GET /api/manage/v1/Subscriptions/{subscriptionId}/users Returns all users of subscription
subscriptionUsersLeaveSubscripiton() DELETE /api/manage/v1/Subscriptions/{subscriptionId}/leave Allows user to leave subscription,.
subscriptionUsersRemoveUser() DELETE /api/manage/v1/Subscriptions/{subscriptionId}/users/{userId} Delete a user from the subscription, the added users will be displayed in the list of users of the subscription, and these users will also have an active subscription.

subscriptionUsersAddUser()

subscriptionUsersAddUser($subscription_id, $user_id)

Add a user to the subscription, the added users will be displayed in the list of users of the subscription, and these users will also have an active 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\SubscriptionUsersApi(
    // 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 | Idenitifier of subscription
$user_id = 'user_id_example'; // string | Idenitifier of user

try {
    $apiInstance->subscriptionUsersAddUser($subscription_id, $user_id);
} catch (Exception $e) {
    echo 'Exception when calling SubscriptionUsersApi->subscriptionUsersAddUser: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
subscription_id string Idenitifier of subscription
user_id string Idenitifier of user

Return type

void (empty response body)

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]

subscriptionUsersCountUsersAsync()

subscriptionUsersCountUsersAsync($subscription_id): int

Returns a number of users in 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\SubscriptionUsersApi(
    // 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 | 

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

Parameters

Name Type Description Notes
subscription_id string

Return type

int

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]

subscriptionUsersGetUsers()

subscriptionUsersGetUsers($subscription_id, $skip, $take): \OpenAPI\Client\cloud\fastreport\model\SubscriptionUsersVM

Returns all users of 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\SubscriptionUsersApi(
    // 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 | Idenitifier of subscription
$skip = 0; // int | How many entities skip
$take = 10; // int | How many entities take

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

Parameters

Name Type Description Notes
subscription_id string Idenitifier of subscription
skip int How many entities skip [optional] [default to 0]
take int How many entities take [optional] [default to 10]

Return type

\OpenAPI\Client\cloud\fastreport\model\SubscriptionUsersVM

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]

subscriptionUsersLeaveSubscripiton()

subscriptionUsersLeaveSubscripiton($subscription_id)

Allows user to leave 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\SubscriptionUsersApi(
    // 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 | Idenitifier of subscription

try {
    $apiInstance->subscriptionUsersLeaveSubscripiton($subscription_id);
} catch (Exception $e) {
    echo 'Exception when calling SubscriptionUsersApi->subscriptionUsersLeaveSubscripiton: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
subscription_id string Idenitifier of subscription

Return type

void (empty response body)

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]

subscriptionUsersRemoveUser()

subscriptionUsersRemoveUser($subscription_id, $user_id)

Delete a user from the subscription, the added users will be displayed in the list of users of the subscription, and these users will also have an active 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\SubscriptionUsersApi(
    // 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 | Idenitifier of subscription
$user_id = 'user_id_example'; // string | Idenitifier of user

try {
    $apiInstance->subscriptionUsersRemoveUser($subscription_id, $user_id);
} catch (Exception $e) {
    echo 'Exception when calling SubscriptionUsersApi->subscriptionUsersRemoveUser: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
subscription_id string Idenitifier of subscription
user_id string Idenitifier of user

Return type

void (empty response body)

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]