Skip to content

AuthenticationUsersApi.md

Latest commit

 

History

History
410 lines (281 loc) · 13.8 KB

AuthenticationUsersApi.md

File metadata and controls

410 lines (281 loc) · 13.8 KB

revengai.AuthenticationUsersApi

All URIs are relative to https://api.reveng.ai

Method HTTP request Description
get_requester_user_info GET /v2/users/me Get the requesters user information
get_user GET /v2/users/{user_id} Get a user's public information
get_user_activity GET /v2/users/activity Get auth user activity
get_user_comments GET /v2/users/me/comments Get comments by user
submit_user_feedback POST /v2/users/feedback Submit feedback about the application

get_requester_user_info

BaseResponseGetMeResponse get_requester_user_info()

Get the requesters user information

Example

  • Api Key Authentication (APIKey):
import revengai
from revengai.models.base_response_get_me_response import BaseResponseGetMeResponse
from revengai.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.reveng.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = revengai.Configuration(
    host = "https://api.reveng.ai"
)

# 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 API key authorization: APIKey
configuration.api_key['APIKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['APIKey'] = 'Bearer'

# Enter a context with an instance of the API client
with revengai.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = revengai.AuthenticationUsersApi(api_client)

    try:
        # Get the requesters user information
        api_response = api_instance.get_requester_user_info()
        print("The response of AuthenticationUsersApi->get_requester_user_info:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthenticationUsersApi->get_requester_user_info: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

BaseResponseGetMeResponse

Authorization

APIKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Invalid request parameters -

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

get_user

BaseResponseGetPublicUserResponse get_user(user_id)

Get a user's public information

Example

  • Api Key Authentication (APIKey):
import revengai
from revengai.models.base_response_get_public_user_response import BaseResponseGetPublicUserResponse
from revengai.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.reveng.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = revengai.Configuration(
    host = "https://api.reveng.ai"
)

# 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 API key authorization: APIKey
configuration.api_key['APIKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['APIKey'] = 'Bearer'

# Enter a context with an instance of the API client
with revengai.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = revengai.AuthenticationUsersApi(api_client)
    user_id = 56 # int | 

    try:
        # Get a user's public information
        api_response = api_instance.get_user(user_id)
        print("The response of AuthenticationUsersApi->get_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthenticationUsersApi->get_user: %s\n" % e)

Parameters

Name Type Description Notes
user_id int

Return type

BaseResponseGetPublicUserResponse

Authorization

APIKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Invalid request parameters -

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

get_user_activity

BaseResponseListUserActivityResponse get_user_activity()

Get auth user activity

Example

  • Api Key Authentication (APIKey):
import revengai
from revengai.models.base_response_list_user_activity_response import BaseResponseListUserActivityResponse
from revengai.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.reveng.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = revengai.Configuration(
    host = "https://api.reveng.ai"
)

# 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 API key authorization: APIKey
configuration.api_key['APIKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['APIKey'] = 'Bearer'

# Enter a context with an instance of the API client
with revengai.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = revengai.AuthenticationUsersApi(api_client)

    try:
        # Get auth user activity
        api_response = api_instance.get_user_activity()
        print("The response of AuthenticationUsersApi->get_user_activity:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthenticationUsersApi->get_user_activity: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

BaseResponseListUserActivityResponse

Authorization

APIKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Invalid request parameters -

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

get_user_comments

BaseResponseListCommentResponse get_user_comments(endpoint_url=endpoint_url, local_cache_dir=local_cache_dir, local_cache_max_size_mb=local_cache_max_size_mb, customer_samples_bucket=customer_samples_bucket, firmware_samples_bucket=firmware_samples_bucket, max_retry_attempts=max_retry_attempts)

Get comments by user

Retrieves all comments created by a specific user. Only returns comments for resources the requesting user has access to.

Example

  • Api Key Authentication (APIKey):
import revengai
from revengai.models.base_response_list_comment_response import BaseResponseListCommentResponse
from revengai.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.reveng.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = revengai.Configuration(
    host = "https://api.reveng.ai"
)

# 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 API key authorization: APIKey
configuration.api_key['APIKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['APIKey'] = 'Bearer'

# Enter a context with an instance of the API client
with revengai.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = revengai.AuthenticationUsersApi(api_client)
    endpoint_url = 'endpoint_url_example' # str |  (optional)
    local_cache_dir = 'local_cache_dir_example' # str |  (optional)
    local_cache_max_size_mb = 56 # int |  (optional)
    customer_samples_bucket = 'customer_samples_bucket_example' # str |  (optional)
    firmware_samples_bucket = 'firmware_samples_bucket_example' # str |  (optional)
    max_retry_attempts = 5 # int |  (optional) (default to 5)

    try:
        # Get comments by user
        api_response = api_instance.get_user_comments(endpoint_url=endpoint_url, local_cache_dir=local_cache_dir, local_cache_max_size_mb=local_cache_max_size_mb, customer_samples_bucket=customer_samples_bucket, firmware_samples_bucket=firmware_samples_bucket, max_retry_attempts=max_retry_attempts)
        print("The response of AuthenticationUsersApi->get_user_comments:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthenticationUsersApi->get_user_comments: %s\n" % e)

Parameters

Name Type Description Notes
endpoint_url str [optional]
local_cache_dir str [optional]
local_cache_max_size_mb int [optional]
customer_samples_bucket str [optional]
firmware_samples_bucket str [optional]
max_retry_attempts int [optional] [default to 5]

Return type

BaseResponseListCommentResponse

Authorization

APIKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Invalid request parameters -

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

submit_user_feedback

BaseResponse submit_user_feedback(submit_user_feedback_request)

Submit feedback about the application

Submits feedback about the application and forwards it to the RevEng.ai project management tool.

Example

  • Api Key Authentication (APIKey):
import revengai
from revengai.models.base_response import BaseResponse
from revengai.models.submit_user_feedback_request import SubmitUserFeedbackRequest
from revengai.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.reveng.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = revengai.Configuration(
    host = "https://api.reveng.ai"
)

# 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 API key authorization: APIKey
configuration.api_key['APIKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['APIKey'] = 'Bearer'

# Enter a context with an instance of the API client
with revengai.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = revengai.AuthenticationUsersApi(api_client)
    submit_user_feedback_request = revengai.SubmitUserFeedbackRequest() # SubmitUserFeedbackRequest | 

    try:
        # Submit feedback about the application
        api_response = api_instance.submit_user_feedback(submit_user_feedback_request)
        print("The response of AuthenticationUsersApi->submit_user_feedback:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthenticationUsersApi->submit_user_feedback: %s\n" % e)

Parameters

Name Type Description Notes
submit_user_feedback_request SubmitUserFeedbackRequest

Return type

BaseResponse

Authorization

APIKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Invalid request parameters -

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