Skip to content

AutopostApi.md

Latest commit

 

History

History
372 lines (237 loc) · 9.87 KB

AutopostApi.md

File metadata and controls

372 lines (237 loc) · 9.87 KB

postiz_python_client.AutopostApi

All URIs are relative to http://localhost

Method HTTP request Description
autopost_controller_change_active POST /autopost/{id}/active
autopost_controller_create_autopost POST /autopost
autopost_controller_delete_autopost DELETE /autopost/{id}
autopost_controller_get_autoposts GET /autopost
autopost_controller_send_webhook POST /autopost/send
autopost_controller_update_autopost PUT /autopost/{id}

autopost_controller_change_active

autopost_controller_change_active(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.AutopostApi(api_client)
    id = 'id_example' # str | 

    try:
        api_instance.autopost_controller_change_active(id)
    except Exception as e:
        print("Exception when calling AutopostApi->autopost_controller_change_active: %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]

autopost_controller_create_autopost

autopost_controller_create_autopost(body)

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.AutopostApi(api_client)
    body = None # object | 

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

Parameters

Name Type Description Notes
body object

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

autopost_controller_delete_autopost

autopost_controller_delete_autopost(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.AutopostApi(api_client)
    id = 'id_example' # str | 

    try:
        api_instance.autopost_controller_delete_autopost(id)
    except Exception as e:
        print("Exception when calling AutopostApi->autopost_controller_delete_autopost: %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]

autopost_controller_get_autoposts

autopost_controller_get_autoposts()

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.AutopostApi(api_client)

    try:
        api_instance.autopost_controller_get_autoposts()
    except Exception as e:
        print("Exception when calling AutopostApi->autopost_controller_get_autoposts: %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]

autopost_controller_send_webhook

autopost_controller_send_webhook(url)

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.AutopostApi(api_client)
    url = 'url_example' # str | 

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

Parameters

Name Type Description Notes
url 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]

autopost_controller_update_autopost

autopost_controller_update_autopost(id, body)

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.AutopostApi(api_client)
    id = 'id_example' # str | 
    body = None # object | 

    try:
        api_instance.autopost_controller_update_autopost(id, body)
    except Exception as e:
        print("Exception when calling AutopostApi->autopost_controller_update_autopost: %s\n" % e)

Parameters

Name Type Description Notes
id str
body object

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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