Skip to content

PublicAPIApi.md

Latest commit

 

History

History
594 lines (376 loc) · 16.6 KB

PublicAPIApi.md

File metadata and controls

594 lines (376 loc) · 16.6 KB

postiz_python_client.PublicAPIApi

All URIs are relative to http://localhost

Method HTTP request Description
public_integrations_controller_create_post POST /public/v1/posts
public_integrations_controller_delete_post DELETE /public/v1/posts/{id}
public_integrations_controller_find_slot_integration GET /public/v1/find-slot/{id}
public_integrations_controller_generate_video POST /public/v1/generate-video
public_integrations_controller_get_active_integrations GET /public/v1/is-connected
public_integrations_controller_get_posts GET /public/v1/posts
public_integrations_controller_list_integration GET /public/v1/integrations
public_integrations_controller_upload_simple POST /public/v1/upload
public_integrations_controller_uploads_from_url POST /public/v1/upload-from-url
public_integrations_controller_video_function POST /public/v1/video/function

public_integrations_controller_create_post

public_integrations_controller_create_post()

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

    try:
        api_instance.public_integrations_controller_create_post()
    except Exception as e:
        print("Exception when calling PublicAPIApi->public_integrations_controller_create_post: %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
201 -

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

public_integrations_controller_delete_post

public_integrations_controller_delete_post()

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

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

public_integrations_controller_find_slot_integration

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

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

public_integrations_controller_generate_video

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

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

public_integrations_controller_get_active_integrations

public_integrations_controller_get_active_integrations()

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

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

public_integrations_controller_get_posts

public_integrations_controller_get_posts()

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

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

public_integrations_controller_list_integration

public_integrations_controller_list_integration()

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

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

public_integrations_controller_upload_simple

public_integrations_controller_upload_simple()

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

    try:
        api_instance.public_integrations_controller_upload_simple()
    except Exception as e:
        print("Exception when calling PublicAPIApi->public_integrations_controller_upload_simple: %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
201 -

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

public_integrations_controller_uploads_from_url

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

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

public_integrations_controller_video_function

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

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