Skip to content

Latest commit

 

History

History
361 lines (257 loc) · 13 KB

SubscriptionInvitesApi.md

File metadata and controls

361 lines (257 loc) · 13 KB

fastreport_cloud_sdk.SubscriptionInvitesApi

All URIs are relative to http://localhost

Method HTTP request Description
subscription_invites_accept_invite GET /api/manage/v1/Subscriptions/{subscriptionId}/invite/{accessToken}/accept Add the current user to the subscription using invite,
subscription_invites_create_invite POST /api/manage/v1/Subscriptions/{subscriptionId}/invite Create invite to subscription
subscription_invites_delete_invite DELETE /api/manage/v1/Subscriptions/{subscriptionId}/invite/{accesstoken} Delete invite with specified token
subscription_invites_get_invites 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.

subscription_invites_accept_invite

subscription_invites_accept_invite(subscription_id, access_token)

Add the current user to the subscription using invite,

Example

  • Basic Authentication (ApiKey):
  • Bearer (JWT) Authentication (JWT):
import fastreport_cloud_sdk
from fastreport_cloud_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = fastreport_cloud_sdk.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: ApiKey
configuration = fastreport_cloud_sdk.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with fastreport_cloud_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = fastreport_cloud_sdk.SubscriptionInvitesApi(api_client)
    subscription_id = 'subscription_id_example' # str | Idenitifier of subscription
    access_token = 'access_token_example' # str | access token of the subscription

    try:
        # Add the current user to the subscription using invite,
        api_instance.subscription_invites_accept_invite(subscription_id, access_token)
    except Exception as e:
        print("Exception when calling SubscriptionInvitesApi->subscription_invites_accept_invite: %s\n" % e)

Parameters

Name Type Description Notes
subscription_id str Idenitifier of subscription
access_token str access token of the subscription

Return type

void (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 request is wrong -
403 You don't have permissions for the operation -
404 Subscription or user is not found -

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

subscription_invites_create_invite

SubscriptionInviteVM subscription_invites_create_invite(subscription_id, create_subscription_invite_vm=create_subscription_invite_vm)

Create invite to subscription

Example

  • Basic Authentication (ApiKey):
  • Bearer (JWT) Authentication (JWT):
import fastreport_cloud_sdk
from fastreport_cloud_sdk.models.create_subscription_invite_vm import CreateSubscriptionInviteVM
from fastreport_cloud_sdk.models.subscription_invite_vm import SubscriptionInviteVM
from fastreport_cloud_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = fastreport_cloud_sdk.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: ApiKey
configuration = fastreport_cloud_sdk.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with fastreport_cloud_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = fastreport_cloud_sdk.SubscriptionInvitesApi(api_client)
    subscription_id = 'subscription_id_example' # str | id
    create_subscription_invite_vm = fastreport_cloud_sdk.CreateSubscriptionInviteVM() # CreateSubscriptionInviteVM | create VM (optional)

    try:
        # Create invite to subscription
        api_response = api_instance.subscription_invites_create_invite(subscription_id, create_subscription_invite_vm=create_subscription_invite_vm)
        print("The response of SubscriptionInvitesApi->subscription_invites_create_invite:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SubscriptionInvitesApi->subscription_invites_create_invite: %s\n" % e)

Parameters

Name Type Description Notes
subscription_id str id
create_subscription_invite_vm 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 -

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

subscription_invites_delete_invite

subscription_invites_delete_invite(subscription_id, accesstoken)

Delete invite with specified token

Example

  • Basic Authentication (ApiKey):
  • Bearer (JWT) Authentication (JWT):
import fastreport_cloud_sdk
from fastreport_cloud_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = fastreport_cloud_sdk.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: ApiKey
configuration = fastreport_cloud_sdk.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with fastreport_cloud_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = fastreport_cloud_sdk.SubscriptionInvitesApi(api_client)
    subscription_id = 'subscription_id_example' # str | id
    accesstoken = 'accesstoken_example' # str | invite's token

    try:
        # Delete invite with specified token
        api_instance.subscription_invites_delete_invite(subscription_id, accesstoken)
    except Exception as e:
        print("Exception when calling SubscriptionInvitesApi->subscription_invites_delete_invite: %s\n" % e)

Parameters

Name Type Description Notes
subscription_id str id
accesstoken str invite's token

Return type

void (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 -

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

subscription_invites_get_invites

SubscriptionInvitesVM subscription_invites_get_invites(subscription_id)

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

  • Basic Authentication (ApiKey):
  • Bearer (JWT) Authentication (JWT):
import fastreport_cloud_sdk
from fastreport_cloud_sdk.models.subscription_invites_vm import SubscriptionInvitesVM
from fastreport_cloud_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = fastreport_cloud_sdk.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: ApiKey
configuration = fastreport_cloud_sdk.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with fastreport_cloud_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = fastreport_cloud_sdk.SubscriptionInvitesApi(api_client)
    subscription_id = 'subscription_id_example' # str | Idenitifier of subscription

    try:
        # 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.
        api_response = api_instance.subscription_invites_get_invites(subscription_id)
        print("The response of SubscriptionInvitesApi->subscription_invites_get_invites:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SubscriptionInvitesApi->subscription_invites_get_invites: %s\n" % e)

Parameters

Name Type Description Notes
subscription_id str 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 request is wrong -
402 The subscription is blocked -
403 You don't have permissions for the operation -
404 Subscription or user is not found -

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