Skip to content

QuestionsAndAnswersApi.md

Latest commit

 

History

History
251 lines (172 loc) · 8.23 KB

QuestionsAndAnswersApi.md

File metadata and controls

251 lines (172 loc) · 8.23 KB
Raw

wordlift_client.QuestionsAndAnswersApi

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

Method HTTP request Description
create_question_and_answer_in_set POST /content-optimizations/questions-and-answers-sets/{id}/questions-and-answers Create
delete_question_and_answer DELETE /content-optimizations/questions-and-answers-sets/{id}/questions-and-answers/{questionAndAnswerId} Delete
update_question_and_answer PUT /content-optimizations/questions-and-answers-sets/{id}/questions-and-answers/{questionAndAnswerId} Update

create_question_and_answer_in_set

QuestionAndAnswer create_question_and_answer_in_set(id)

Create

Example

  • Api Key Authentication (ApiKey):
import wordlift_client
from wordlift_client.models.question_and_answer import QuestionAndAnswer
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.QuestionsAndAnswersApi(api_client)
    id = 'id_example' # str | 

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

Parameters

Name Type Description Notes
id str

Return type

QuestionAndAnswer

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
201 Created -
401 Authentication Failure -

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

delete_question_and_answer

delete_question_and_answer(id, question_and_answer_id)

Delete

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

    try:
        # Delete
        await api_instance.delete_question_and_answer(id, question_and_answer_id)
    except Exception as e:
        print("Exception when calling QuestionsAndAnswersApi->delete_question_and_answer: %s\n" % e)

Parameters

Name Type Description Notes
id str
question_and_answer_id str

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
200 Found. -
401 Authentication Failure -
404 Not Found -

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

update_question_and_answer

QuestionAndAnswer update_question_and_answer(id, question_and_answer_id, update_question_and_answer_request)

Update

Example

  • Api Key Authentication (ApiKey):
import wordlift_client
from wordlift_client.models.question_and_answer import QuestionAndAnswer
from wordlift_client.models.update_question_and_answer_request import UpdateQuestionAndAnswerRequest
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.QuestionsAndAnswersApi(api_client)
    id = 'id_example' # str | 
    question_and_answer_id = 'question_and_answer_id_example' # str | 
    update_question_and_answer_request = wordlift_client.UpdateQuestionAndAnswerRequest() # UpdateQuestionAndAnswerRequest | 

    try:
        # Update
        api_response = await api_instance.update_question_and_answer(id, question_and_answer_id, update_question_and_answer_request)
        print("The response of QuestionsAndAnswersApi->update_question_and_answer:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling QuestionsAndAnswersApi->update_question_and_answer: %s\n" % e)

Parameters

Name Type Description Notes
id str
question_and_answer_id str
update_question_and_answer_request UpdateQuestionAndAnswerRequest

Return type

QuestionAndAnswer

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Found. -
401 Authentication Failure -
404 Not Found -

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