Skip to content

Latest commit

 

History

History
368 lines (234 loc) · 10 KB

ThirdPartyApi.md

File metadata and controls

368 lines (234 loc) · 10 KB

postiz_python_client.ThirdPartyApi

All URIs are relative to http://localhost

Method HTTP request Description
third_party_controller_add_api_key POST /third-party/{identifier}
third_party_controller_call_function POST /third-party/function/{id}/{functionName}
third_party_controller_delete_by_id DELETE /third-party/{id}
third_party_controller_generate POST /third-party/{id}/submit
third_party_controller_get_saved_third_party GET /third-party
third_party_controller_get_third_party_list GET /third-party/list

third_party_controller_add_api_key

third_party_controller_add_api_key(identifier)

Example

import postiz_python_client
from postiz_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = postiz_python_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with postiz_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = postiz_python_client.ThirdPartyApi(api_client)
    identifier = 'identifier_example' # str | 

    try:
        api_instance.third_party_controller_add_api_key(identifier)
    except Exception as e:
        print("Exception when calling ThirdPartyApi->third_party_controller_add_api_key: %s\n" % e)

Parameters

Name Type Description Notes
identifier str

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
201 -

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

third_party_controller_call_function

third_party_controller_call_function(id, function_name)

Example

import postiz_python_client
from postiz_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = postiz_python_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with postiz_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = postiz_python_client.ThirdPartyApi(api_client)
    id = 'id_example' # str | 
    function_name = 'function_name_example' # str | 

    try:
        api_instance.third_party_controller_call_function(id, function_name)
    except Exception as e:
        print("Exception when calling ThirdPartyApi->third_party_controller_call_function: %s\n" % e)

Parameters

Name Type Description Notes
id str
function_name str

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
201 -

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

third_party_controller_delete_by_id

third_party_controller_delete_by_id(id)

Example

import postiz_python_client
from postiz_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = postiz_python_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with postiz_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = postiz_python_client.ThirdPartyApi(api_client)
    id = 'id_example' # str | 

    try:
        api_instance.third_party_controller_delete_by_id(id)
    except Exception as e:
        print("Exception when calling ThirdPartyApi->third_party_controller_delete_by_id: %s\n" % e)

Parameters

Name Type Description Notes
id str

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
200 -

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

third_party_controller_generate

third_party_controller_generate(id)

Example

import postiz_python_client
from postiz_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = postiz_python_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with postiz_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = postiz_python_client.ThirdPartyApi(api_client)
    id = 'id_example' # str | 

    try:
        api_instance.third_party_controller_generate(id)
    except Exception as e:
        print("Exception when calling ThirdPartyApi->third_party_controller_generate: %s\n" % e)

Parameters

Name Type Description Notes
id str

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
201 -

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

third_party_controller_get_saved_third_party

third_party_controller_get_saved_third_party()

Example

import postiz_python_client
from postiz_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = postiz_python_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with postiz_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = postiz_python_client.ThirdPartyApi(api_client)

    try:
        api_instance.third_party_controller_get_saved_third_party()
    except Exception as e:
        print("Exception when calling ThirdPartyApi->third_party_controller_get_saved_third_party: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
200 -

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

third_party_controller_get_third_party_list

third_party_controller_get_third_party_list()

Example

import postiz_python_client
from postiz_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = postiz_python_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with postiz_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = postiz_python_client.ThirdPartyApi(api_client)

    try:
        api_instance.third_party_controller_get_third_party_list()
    except Exception as e:
        print("Exception when calling ThirdPartyApi->third_party_controller_get_third_party_list: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
200 -

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