Skip to content

Latest commit

 

History

History
458 lines (329 loc) · 15.1 KB

ContactGroupsApi.md

File metadata and controls

458 lines (329 loc) · 15.1 KB

fastreport_cloud_sdk.ContactGroupsApi

All URIs are relative to http://localhost

Method HTTP request Description
contact_groups_create POST /api/v1/ContactGroups/group Creates contact group
contact_groups_delete DELETE /api/v1/ContactGroups/{id} Removes contact by id
contact_groups_get GET /api/v1/ContactGroups/{id} Returns contact group by id
contact_groups_get_list GET /api/v1/ContactGroups/subscription/{subscriptionId}/groups Returns contact groups by subscriptionId
contact_groups_update PUT /api/v1/ContactGroups/{id} Updates contact group by id

contact_groups_create

ContactGroupVM contact_groups_create(create_contact_group_vm=create_contact_group_vm)

Creates contact group

Example

  • Basic Authentication (ApiKey):
  • Bearer (JWT) Authentication (JWT):
import fastreport_cloud_sdk
from fastreport_cloud_sdk.models.contact_group_vm import ContactGroupVM
from fastreport_cloud_sdk.models.create_contact_group_vm import CreateContactGroupVM
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.ContactGroupsApi(api_client)
    create_contact_group_vm = fastreport_cloud_sdk.CreateContactGroupVM() # CreateContactGroupVM |  (optional)

    try:
        # Creates contact group
        api_response = api_instance.contact_groups_create(create_contact_group_vm=create_contact_group_vm)
        print("The response of ContactGroupsApi->contact_groups_create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContactGroupsApi->contact_groups_create: %s\n" % e)

Parameters

Name Type Description Notes
create_contact_group_vm CreateContactGroupVM [optional]

Return type

ContactGroupVM

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 Contact group was created -
400 Bad VM provided -
402 Subscription is outdated -
403 Not enough permissions for the operation -
404 Subscription was not found -
500 Try again, if error still here - text our support -

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

contact_groups_delete

contact_groups_delete(id)

Removes contact by id

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.ContactGroupsApi(api_client)
    id = 'id_example' # str | 

    try:
        # Removes contact by id
        api_instance.contact_groups_delete(id)
    except Exception as e:
        print("Exception when calling ContactGroupsApi->contact_groups_delete: %s\n" % e)

Parameters

Name Type Description Notes
id str

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 Contact group was deleted -
400 Bad id provided -
402 Subscription is outdated -
403 Not enough permissions for the operation -
404 Subscription or group was not found -
500 Try again, if error still here - text our support -

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

contact_groups_get

ContactGroupVM contact_groups_get(id)

Returns contact group by id

Example

  • Basic Authentication (ApiKey):
  • Bearer (JWT) Authentication (JWT):
import fastreport_cloud_sdk
from fastreport_cloud_sdk.models.contact_group_vm import ContactGroupVM
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.ContactGroupsApi(api_client)
    id = 'id_example' # str | 

    try:
        # Returns contact group by id
        api_response = api_instance.contact_groups_get(id)
        print("The response of ContactGroupsApi->contact_groups_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContactGroupsApi->contact_groups_get: %s\n" % e)

Parameters

Name Type Description Notes
id str

Return type

ContactGroupVM

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Contact group was found -
400 Bad id provided -
402 Subscription is outdated -
403 Not enough permissions for the operation -
404 Subscription or group was not found -
500 Try again, if error still here - text our support -

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

contact_groups_get_list

ContactGroupsVM contact_groups_get_list(subscription_id, skip=skip, take=take)

Returns contact groups by subscriptionId

Example

  • Basic Authentication (ApiKey):
  • Bearer (JWT) Authentication (JWT):
import fastreport_cloud_sdk
from fastreport_cloud_sdk.models.contact_groups_vm import ContactGroupsVM
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.ContactGroupsApi(api_client)
    subscription_id = 'subscription_id_example' # str | 
    skip = 0 # int |  (optional) (default to 0)
    take = 10 # int |  (optional) (default to 10)

    try:
        # Returns contact groups by subscriptionId
        api_response = api_instance.contact_groups_get_list(subscription_id, skip=skip, take=take)
        print("The response of ContactGroupsApi->contact_groups_get_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContactGroupsApi->contact_groups_get_list: %s\n" % e)

Parameters

Name Type Description Notes
subscription_id str
skip int [optional] [default to 0]
take int [optional] [default to 10]

Return type

ContactGroupsVM

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Contact groups were found -
403 Not enough permissions for the operation -
404 Subscription was not found -
402 Subscription is outdated -
400 Bad id provided -
500 Try again, if error still here - text our support -

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

contact_groups_update

ContactGroupVM contact_groups_update(id, update_contact_group_vm=update_contact_group_vm)

Updates contact group by id

Example

  • Basic Authentication (ApiKey):
  • Bearer (JWT) Authentication (JWT):
import fastreport_cloud_sdk
from fastreport_cloud_sdk.models.contact_group_vm import ContactGroupVM
from fastreport_cloud_sdk.models.update_contact_group_vm import UpdateContactGroupVM
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.ContactGroupsApi(api_client)
    id = 'id_example' # str | 
    update_contact_group_vm = fastreport_cloud_sdk.UpdateContactGroupVM() # UpdateContactGroupVM |  (optional)

    try:
        # Updates contact group by id
        api_response = api_instance.contact_groups_update(id, update_contact_group_vm=update_contact_group_vm)
        print("The response of ContactGroupsApi->contact_groups_update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContactGroupsApi->contact_groups_update: %s\n" % e)

Parameters

Name Type Description Notes
id str
update_contact_group_vm UpdateContactGroupVM [optional]

Return type

ContactGroupVM

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 Contact group was updated -
400 Bad VM or id provided -
402 Subscription is outdated -
403 Not enough permissions for the operation -
404 Subscription or group was not found -
500 Try again, if error still here - text our support -

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