Skip to content

Latest commit

 

History

History
248 lines (157 loc) · 6.3 KB

File metadata and controls

248 lines (157 loc) · 6.3 KB

postiz_python_client.SetsApi

All URIs are relative to http://localhost

Method HTTP request Description
sets_controller_create_a_set POST /sets
sets_controller_delete_set DELETE /sets/{id}
sets_controller_get_sets GET /sets
sets_controller_update_set PUT /sets

sets_controller_create_a_set

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

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

sets_controller_delete_set

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

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

sets_controller_get_sets

sets_controller_get_sets()

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

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

sets_controller_update_set

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

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

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