Skip to content

Latest commit

 

History

History
170 lines (116 loc) · 5.41 KB

ContentGenerationFieldsApi.md

File metadata and controls

170 lines (116 loc) · 5.41 KB
Raw

wordlift_client.ContentGenerationFieldsApi

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

Method HTTP request Description
list_fields GET /content-generations/{contentGenerationId}/fields List
list_fields_for_graph_ql_query POST /fields List for GraphQl Query

list_fields

PageField list_fields(content_generation_id, cursor=cursor, limit=limit)

List

Example

  • Api Key Authentication (ApiKey):
import wordlift_client
from wordlift_client.models.page_field import PageField
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.ContentGenerationFieldsApi(api_client)
    content_generation_id = 56 # int | The Content Generation id.
    cursor = 'cursor_example' # str | The cursor (optional)
    limit = 10 # int | The maximum number of results (optional) (default to 10)

    try:
        # List
        api_response = await api_instance.list_fields(content_generation_id, cursor=cursor, limit=limit)
        print("The response of ContentGenerationFieldsApi->list_fields:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentGenerationFieldsApi->list_fields: %s\n" % e)

Parameters

Name Type Description Notes
content_generation_id int The Content Generation id.
cursor str The cursor [optional]
limit int The maximum number of results [optional] [default to 10]

Return type

PageField

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]

list_fields_for_graph_ql_query

List[ModelField] list_fields_for_graph_ql_query(body)

List for GraphQl Query

Example

  • Api Key Authentication (ApiKey):
import wordlift_client
from wordlift_client.models.model_field import ModelField
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.ContentGenerationFieldsApi(api_client)
    body = 'body_example' # str | 

    try:
        # List for GraphQl Query
        api_response = await api_instance.list_fields_for_graph_ql_query(body)
        print("The response of ContentGenerationFieldsApi->list_fields_for_graph_ql_query:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentGenerationFieldsApi->list_fields_for_graph_ql_query: %s\n" % e)

Parameters

Name Type Description Notes
body str

Return type

List[ModelField]

Authorization

ApiKey

HTTP request headers

  • Content-Type: application/graphql
  • 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]