Skip to content

AccountConnectorFieldControllerApi.md

Latest commit

 

History

History
245 lines (163 loc) · 7.46 KB

AccountConnectorFieldControllerApi.md

File metadata and controls

245 lines (163 loc) · 7.46 KB
Raw

wordlift_client.AccountConnectorFieldControllerApi

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

Method HTTP request Description
delete_field DELETE /accounts/{account_id}/oauth2/connectors/{connector_id}/fields/{field_name}
fields GET /accounts/{account_id}/oauth2/connectors/{connector_id}/fields
put_field PUT /accounts/{account_id}/oauth2/connectors/{connector_id}/fields/{field_name}

delete_field

delete_field(account_id, connector_id, field_name)

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.AccountConnectorFieldControllerApi(api_client)
    account_id = 56 # int | 
    connector_id = 'connector_id_example' # str | 
    field_name = 'field_name_example' # str | 

    try:
        await api_instance.delete_field(account_id, connector_id, field_name)
    except Exception as e:
        print("Exception when calling AccountConnectorFieldControllerApi->delete_field: %s\n" % e)

Parameters

Name Type Description Notes
account_id int
connector_id str
field_name 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
204 No Content -

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

fields

Dict[str, str] fields(account_id, connector_id)

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.AccountConnectorFieldControllerApi(api_client)
    account_id = 56 # int | 
    connector_id = 'connector_id_example' # str | 

    try:
        api_response = await api_instance.fields(account_id, connector_id)
        print("The response of AccountConnectorFieldControllerApi->fields:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AccountConnectorFieldControllerApi->fields: %s\n" % e)

Parameters

Name Type Description Notes
account_id int
connector_id str

Return type

Dict[str, str]

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status code Description Response headers
200 OK -

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

put_field

put_field(account_id, connector_id, field_name, field_value_request)

Example

  • Api Key Authentication (ApiKey):
import wordlift_client
from wordlift_client.models.field_value_request import FieldValueRequest
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.AccountConnectorFieldControllerApi(api_client)
    account_id = 56 # int | 
    connector_id = 'connector_id_example' # str | 
    field_name = 'field_name_example' # str | 
    field_value_request = wordlift_client.FieldValueRequest() # FieldValueRequest | 

    try:
        await api_instance.put_field(account_id, connector_id, field_name, field_value_request)
    except Exception as e:
        print("Exception when calling AccountConnectorFieldControllerApi->put_field: %s\n" % e)

Parameters

Name Type Description Notes
account_id int
connector_id str
field_name str
field_value_request FieldValueRequest

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 No Content -

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