Skip to content

Latest commit

 

History

History
93 lines (63 loc) · 2.9 KB

AddOnsApi.md

File metadata and controls

93 lines (63 loc) · 2.9 KB
Raw

wordlift_client.AddOnsApi

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

Method HTTP request Description
list_configurations GET /addon/configurations List

list_configurations

PageAddOnConfiguration list_configurations(token=token, key=key, limit=limit)

List

List the Add-ons configurations

Example

  • Api Key Authentication (ApiKey):
import wordlift_client
from wordlift_client.models.page_add_on_configuration import PageAddOnConfiguration
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.AddOnsApi(api_client)
    token = 'token_example' # str | The access token (optional)
    key = 'key_example' # str | The key (optional)
    limit = 10 # int | The maximum number of results (optional) (default to 10)

    try:
        # List
        api_response = await api_instance.list_configurations(token=token, key=key, limit=limit)
        print("The response of AddOnsApi->list_configurations:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AddOnsApi->list_configurations: %s\n" % e)

Parameters

Name Type Description Notes
token str The access token [optional]
key str The key [optional]
limit int The maximum number of results [optional] [default to 10]

Return type

PageAddOnConfiguration

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/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]