Skip to content

AccountApi.md

Latest commit

 

History

History
238 lines (158 loc) · 6.74 KB

AccountApi.md

File metadata and controls

238 lines (158 loc) · 6.74 KB

wordlift_client.AccountApi

All URIs are relative to https://api.wordlift.io

Method HTTP request Description
clear_cache DELETE /accounts/me/cache Clear Cache
get_me GET /accounts/me Get
reset_me POST /accounts/me/reset Reset

clear_cache

clear_cache()

Clear Cache

Clear the cache for the current account identified by its key.

Example

  • Api Key Authentication (ApiKey):
import wordlift_client
from wordlift_client.rest import ApiException
from pprint import pprint

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

# 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
async with wordlift_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wordlift_client.AccountApi(api_client)

    try:
        # Clear Cache
        await api_instance.clear_cache()
    except Exception as e:
        print("Exception when calling AccountApi->clear_cache: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
204 Cache cleared -
401 Authentication Failure -

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

get_me

AccountInfo get_me()

Get

Get the account data for the current account identified by its key.

Example

  • Api Key Authentication (ApiKey):
import wordlift_client
from wordlift_client.models.account_info import AccountInfo
from wordlift_client.rest import ApiException
from pprint import pprint

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

# 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
async with wordlift_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wordlift_client.AccountApi(api_client)

    try:
        # Get
        api_response = await api_instance.get_me()
        print("The response of AccountApi->get_me:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AccountApi->get_me: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

AccountInfo

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/vnd.wordlift.account-info.v2+json

HTTP response details

Status code Description Response headers
200 Found -
401 Authentication Failure -

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

reset_me

reset_me(reset_account_request=reset_account_request)

Reset

Reset the current account identified by its key.

Example

  • Api Key Authentication (ApiKey):
import wordlift_client
from wordlift_client.models.reset_account_request import ResetAccountRequest
from wordlift_client.rest import ApiException
from pprint import pprint

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

# 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
async with wordlift_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wordlift_client.AccountApi(api_client)
    reset_account_request = wordlift_client.ResetAccountRequest() # ResetAccountRequest |  (optional)

    try:
        # Reset
        await api_instance.reset_me(reset_account_request=reset_account_request)
    except Exception as e:
        print("Exception when calling AccountApi->reset_me: %s\n" % e)

Parameters

Name Type Description Notes
reset_account_request ResetAccountRequest [optional]

Return type

void (empty response body)

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
204 Reset -
401 Authentication Failure -

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