Skip to content

PublicApi.md

Latest commit

 

History

History
598 lines (379 loc) · 15.8 KB

PublicApi.md

File metadata and controls

598 lines (379 loc) · 15.8 KB

postiz_python_client.PublicApi

All URIs are relative to http://localhost

Method HTTP request Description
public_controller_create_agent POST /public/agent
public_controller_crypto_post POST /public/crypto/{path}
public_controller_get_agencies_count GET /public/agencies-list-count
public_controller_get_agency_by_user GET /public/agencies-list
public_controller_get_agency_information GET /public/agencies-information/{agency}
public_controller_get_agency_slug GET /public/agencies-list-slug
public_controller_get_comments GET /public/posts/{id}/comments
public_controller_get_preview GET /public/posts/{id}
public_controller_stream_file GET /public/stream
public_controller_track_event POST /public/t

public_controller_create_agent

public_controller_create_agent()

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

    try:
        api_instance.public_controller_create_agent()
    except Exception as e:
        print("Exception when calling PublicApi->public_controller_create_agent: %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_controller_crypto_post

public_controller_crypto_post(path)

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.PublicApi(api_client)
    path = 'path_example' # str | 

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

Parameters

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

public_controller_get_agencies_count

public_controller_get_agencies_count()

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

    try:
        api_instance.public_controller_get_agencies_count()
    except Exception as e:
        print("Exception when calling PublicApi->public_controller_get_agencies_count: %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_controller_get_agency_by_user

public_controller_get_agency_by_user()

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

    try:
        api_instance.public_controller_get_agency_by_user()
    except Exception as e:
        print("Exception when calling PublicApi->public_controller_get_agency_by_user: %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_controller_get_agency_information

public_controller_get_agency_information(agency)

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.PublicApi(api_client)
    agency = 'agency_example' # str | 

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

Parameters

Name Type Description Notes
agency 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_controller_get_agency_slug

public_controller_get_agency_slug()

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

    try:
        api_instance.public_controller_get_agency_slug()
    except Exception as e:
        print("Exception when calling PublicApi->public_controller_get_agency_slug: %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_controller_get_comments

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

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

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

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

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

    try:
        api_instance.public_controller_stream_file(url)
    except Exception as e:
        print("Exception when calling PublicApi->public_controller_stream_file: %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
200 -

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

public_controller_track_event

public_controller_track_event()

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

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