AgenciesApi.md

postiz_python_client.AgenciesApi

All URIs are relative to http://localhost

Method	HTTP request	Description
agencies_controller_create_agency	POST /agencies
agencies_controller_get_agency_by_users	GET /agencies
agencies_controller_update_agency	POST /agencies/action/{action}/{id}

agencies_controller_create_agency

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

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

agencies_controller_get_agency_by_users

agencies_controller_get_agency_by_users()

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

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

agencies_controller_update_agency

agencies_controller_update_agency(action, 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.AgenciesApi(api_client)
    action = 'action_example' # str | 
    id = 'id_example' # str | 

    try:
        api_instance.agencies_controller_update_agency(action, id)
    except Exception as e:
        print("Exception when calling AgenciesApi->agencies_controller_update_agency: %s\n" % e)

Parameters

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