Skip to content

Latest commit

 

History

History
315 lines (247 loc) · 11.8 KB

SubscriptionInvitesApi.md

File metadata and controls

315 lines (247 loc) · 11.8 KB
Raw

SubscriptionInvitesApi

All URIs are relative to http://localhost

Method HTTP request Description
subscriptionInvitesAcceptInvite GET /api/manage/v1/Subscriptions/{subscriptionId}/invite/{accessToken}/accept Add a user to the subscription using invite, the added users will be displayed in the list of users of the subscription, and these users will also have an active subscription.
subscriptionInvitesCreateInvite POST /api/manage/v1/Subscriptions/{subscriptionId}/invite Create invite to subscription
subscriptionInvitesDeleteInvite DELETE /api/manage/v1/Subscriptions/{subscriptionId}/invite/{accesstoken} Delete invite with specified token
subscriptionInvitesGetInvites GET /api/manage/v1/Subscriptions/{subscriptionId}/invites Get list of invites in a subscription, the added users will be displayed in the list of users of the subscription, and these users will also have an active subscription.

subscriptionInvitesAcceptInvite

subscriptionInvitesAcceptInvite(subscriptionId, accessToken)

Add a user to the subscription using invite, 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 classes:
import cloud.fastreport.ApiClient;
import cloud.fastreport.ApiException;
import cloud.fastreport.Configuration;
import cloud.fastreport.auth.*;
import cloud.fastreport.models.*;
import cloud.fastreport.client.SubscriptionInvitesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure HTTP basic authorization: ApiKey
    HttpBasicAuth ApiKey = (HttpBasicAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setUsername("YOUR USERNAME");
    ApiKey.setPassword("YOUR PASSWORD");

    // Configure HTTP bearer authorization: JWT
    HttpBearerAuth JWT = (HttpBearerAuth) defaultClient.getAuthentication("JWT");
    JWT.setBearerToken("BEARER TOKEN");

    SubscriptionInvitesApi apiInstance = new SubscriptionInvitesApi(defaultClient);
    String subscriptionId = "subscriptionId_example"; // String | Idenitifier of subscription
    String accessToken = "accessToken_example"; // String | access token of the subscription
    try {
      apiInstance.subscriptionInvitesAcceptInvite(subscriptionId, accessToken);
    } catch (ApiException e) {
      System.err.println("Exception when calling SubscriptionInvitesApi#subscriptionInvitesAcceptInvite");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
subscriptionId String Idenitifier of subscription
accessToken String access token of the subscription

Return type

null (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 User already in subscription -
204 Succesfully added -
400 The reqeust is wrong -
403 You don't have rights for the operation -
404 Subscription or user is not found -
500 Exception thrown -

subscriptionInvitesCreateInvite

SubscriptionInviteVM subscriptionInvitesCreateInvite(subscriptionId, createSubscriptionInviteVM)

Create invite to subscription

Example

// Import classes:
import cloud.fastreport.ApiClient;
import cloud.fastreport.ApiException;
import cloud.fastreport.Configuration;
import cloud.fastreport.auth.*;
import cloud.fastreport.models.*;
import cloud.fastreport.client.SubscriptionInvitesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure HTTP basic authorization: ApiKey
    HttpBasicAuth ApiKey = (HttpBasicAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setUsername("YOUR USERNAME");
    ApiKey.setPassword("YOUR PASSWORD");

    // Configure HTTP bearer authorization: JWT
    HttpBearerAuth JWT = (HttpBearerAuth) defaultClient.getAuthentication("JWT");
    JWT.setBearerToken("BEARER TOKEN");

    SubscriptionInvitesApi apiInstance = new SubscriptionInvitesApi(defaultClient);
    String subscriptionId = "subscriptionId_example"; // String | id
    CreateSubscriptionInviteVM createSubscriptionInviteVM = new CreateSubscriptionInviteVM(); // CreateSubscriptionInviteVM | create VM
    try {
      SubscriptionInviteVM result = apiInstance.subscriptionInvitesCreateInvite(subscriptionId, createSubscriptionInviteVM);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SubscriptionInvitesApi#subscriptionInvitesCreateInvite");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
subscriptionId String id
createSubscriptionInviteVM CreateSubscriptionInviteVM create VM [optional]

Return type

SubscriptionInviteVM

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successfully created -
400 Request is wrong -
402 subscription is outdated -
403 Not enough permissions -
404 there is no subscription with such id -
500 exception caught -

subscriptionInvitesDeleteInvite

subscriptionInvitesDeleteInvite(subscriptionId, accesstoken)

Delete invite with specified token

Example

// Import classes:
import cloud.fastreport.ApiClient;
import cloud.fastreport.ApiException;
import cloud.fastreport.Configuration;
import cloud.fastreport.auth.*;
import cloud.fastreport.models.*;
import cloud.fastreport.client.SubscriptionInvitesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure HTTP basic authorization: ApiKey
    HttpBasicAuth ApiKey = (HttpBasicAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setUsername("YOUR USERNAME");
    ApiKey.setPassword("YOUR PASSWORD");

    // Configure HTTP bearer authorization: JWT
    HttpBearerAuth JWT = (HttpBearerAuth) defaultClient.getAuthentication("JWT");
    JWT.setBearerToken("BEARER TOKEN");

    SubscriptionInvitesApi apiInstance = new SubscriptionInvitesApi(defaultClient);
    String subscriptionId = "subscriptionId_example"; // String | id
    String accesstoken = "accesstoken_example"; // String | invite's token
    try {
      apiInstance.subscriptionInvitesDeleteInvite(subscriptionId, accesstoken);
    } catch (ApiException e) {
      System.err.println("Exception when calling SubscriptionInvitesApi#subscriptionInvitesDeleteInvite");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
subscriptionId String id
accesstoken String invite's token

Return type

null (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code Description Response headers
204 Successfully deleted -
400 Request is wrong -
402 subscription is outdated -
403 Not enough permissions -
404 there is no subscription with such id -
500 exception caught -

subscriptionInvitesGetInvites

SubscriptionInvitesVM subscriptionInvitesGetInvites(subscriptionId)

Get list of invites in a 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 classes:
import cloud.fastreport.ApiClient;
import cloud.fastreport.ApiException;
import cloud.fastreport.Configuration;
import cloud.fastreport.auth.*;
import cloud.fastreport.models.*;
import cloud.fastreport.client.SubscriptionInvitesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure HTTP basic authorization: ApiKey
    HttpBasicAuth ApiKey = (HttpBasicAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setUsername("YOUR USERNAME");
    ApiKey.setPassword("YOUR PASSWORD");

    // Configure HTTP bearer authorization: JWT
    HttpBearerAuth JWT = (HttpBearerAuth) defaultClient.getAuthentication("JWT");
    JWT.setBearerToken("BEARER TOKEN");

    SubscriptionInvitesApi apiInstance = new SubscriptionInvitesApi(defaultClient);
    String subscriptionId = "subscriptionId_example"; // String | Idenitifier of subscription
    try {
      SubscriptionInvitesVM result = apiInstance.subscriptionInvitesGetInvites(subscriptionId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SubscriptionInvitesApi#subscriptionInvitesGetInvites");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
subscriptionId String Idenitifier of subscription

Return type

SubscriptionInvitesVM

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Succesfully added -
400 The reqeust is wrong -
403 You don't have rights for the operation -
404 Subscription or user is not found -
500 Exception thrown -