Skip to content

Latest commit

 

History

History
273 lines (184 loc) · 8.47 KB

SubscriptionUsersApi.md

File metadata and controls

273 lines (184 loc) · 8.47 KB
Raw

FastreportCloudSdk.SubscriptionUsersApi

All URIs are relative to http://localhost

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(subscriptionId, 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.

Example

import FastreportCloudSdk from 'fastreport-cloud-sdk';
let defaultClient = FastreportCloudSdk.ApiClient.instance;
// Configure HTTP basic authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.username = 'YOUR USERNAME';
ApiKey.password = 'YOUR PASSWORD';
// Configure Bearer (JWT) access token for authorization: JWT
let JWT = defaultClient.authentications['JWT'];
JWT.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new FastreportCloudSdk.SubscriptionUsersApi();
let subscriptionId = "subscriptionId_example"; // String | Idenitifier of subscription
let userId = "userId_example"; // String | Idenitifier of user
apiInstance.subscriptionUsersAddUser(subscriptionId, userId).then(() => {
  console.log('API called successfully.');
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
subscriptionId String Idenitifier of subscription
userId String Idenitifier of user

Return type

null (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

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

subscriptionUsersCountUsersAsync

Number subscriptionUsersCountUsersAsync(subscriptionId)

Returns a number of users in subscription

Example

import FastreportCloudSdk from 'fastreport-cloud-sdk';
let defaultClient = FastreportCloudSdk.ApiClient.instance;
// Configure HTTP basic authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.username = 'YOUR USERNAME';
ApiKey.password = 'YOUR PASSWORD';
// Configure Bearer (JWT) access token for authorization: JWT
let JWT = defaultClient.authentications['JWT'];
JWT.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new FastreportCloudSdk.SubscriptionUsersApi();
let subscriptionId = "subscriptionId_example"; // String | 
apiInstance.subscriptionUsersCountUsersAsync(subscriptionId).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
subscriptionId String

Return type

Number

Authorization

ApiKey, JWT

HTTP request headers

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

subscriptionUsersGetUsers

SubscriptionUsersVM subscriptionUsersGetUsers(subscriptionId, opts)

Returns all users of subscription

Example

import FastreportCloudSdk from 'fastreport-cloud-sdk';
let defaultClient = FastreportCloudSdk.ApiClient.instance;
// Configure HTTP basic authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.username = 'YOUR USERNAME';
ApiKey.password = 'YOUR PASSWORD';
// Configure Bearer (JWT) access token for authorization: JWT
let JWT = defaultClient.authentications['JWT'];
JWT.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new FastreportCloudSdk.SubscriptionUsersApi();
let subscriptionId = "subscriptionId_example"; // String | Idenitifier of subscription
let opts = {
  'skip': 0, // Number | How many entities skip
  'take': 10 // Number | How many entities take
};
apiInstance.subscriptionUsersGetUsers(subscriptionId, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
subscriptionId String Idenitifier of subscription
skip Number How many entities skip [optional] [default to 0]
take Number How many entities take [optional] [default to 10]

Return type

SubscriptionUsersVM

Authorization

ApiKey, JWT

HTTP request headers

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

subscriptionUsersLeaveSubscripiton

subscriptionUsersLeaveSubscripiton(subscriptionId)

Allows user to leave subscription,.

Example

import FastreportCloudSdk from 'fastreport-cloud-sdk';
let defaultClient = FastreportCloudSdk.ApiClient.instance;
// Configure HTTP basic authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.username = 'YOUR USERNAME';
ApiKey.password = 'YOUR PASSWORD';
// Configure Bearer (JWT) access token for authorization: JWT
let JWT = defaultClient.authentications['JWT'];
JWT.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new FastreportCloudSdk.SubscriptionUsersApi();
let subscriptionId = "subscriptionId_example"; // String | Idenitifier of subscription
apiInstance.subscriptionUsersLeaveSubscripiton(subscriptionId).then(() => {
  console.log('API called successfully.');
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
subscriptionId String Idenitifier of subscription

Return type

null (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

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

subscriptionUsersRemoveUser

subscriptionUsersRemoveUser(subscriptionId, 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.

Example

import FastreportCloudSdk from 'fastreport-cloud-sdk';
let defaultClient = FastreportCloudSdk.ApiClient.instance;
// Configure HTTP basic authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.username = 'YOUR USERNAME';
ApiKey.password = 'YOUR PASSWORD';
// Configure Bearer (JWT) access token for authorization: JWT
let JWT = defaultClient.authentications['JWT'];
JWT.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new FastreportCloudSdk.SubscriptionUsersApi();
let subscriptionId = "subscriptionId_example"; // String | Idenitifier of subscription
let userId = "userId_example"; // String | Idenitifier of user
apiInstance.subscriptionUsersRemoveUser(subscriptionId, userId).then(() => {
  console.log('API called successfully.');
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
subscriptionId String Idenitifier of subscription
userId String Idenitifier of user

Return type

null (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

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