IncludeExcludesApi.md

wordlift_client.IncludeExcludesApi

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

Method	HTTP request	Description
list_include_excludes	GET /accounts/me/include-excludes	List
update_include_excludes	PUT /accounts/me/include-excludes	Update

list_include_excludes

List[IncludeExclude] list_include_excludes()

List

List the include and exclude configurations.

Example

• Api Key Authentication (ApiKey):

import wordlift_client
from wordlift_client.models.include_exclude import IncludeExclude
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.IncludeExcludesApi(api_client)

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

Parameters

This endpoint does not need any parameter.

Return type

List[IncludeExclude]

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Success	-
401	Unauthorized	-
404	Not Found	-

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

update_include_excludes

List[IncludeExclude] update_include_excludes(include_exclude_request)

Update

Update the include and exclude configurations.

Example

• Api Key Authentication (ApiKey):

import wordlift_client
from wordlift_client.models.include_exclude import IncludeExclude
from wordlift_client.models.include_exclude_request import IncludeExcludeRequest
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.IncludeExcludesApi(api_client)
    include_exclude_request = [wordlift_client.IncludeExcludeRequest()] # List[IncludeExcludeRequest] | 

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

Parameters

Name	Type	Description	Notes
include_exclude_request	List[IncludeExcludeRequest]

Return type

List[IncludeExclude]

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Success	-
401	Unauthorized	-
404	Not Found	-

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