Skip to content

SignaturesApi.md

Latest commit

 

History

History
307 lines (195 loc) · 8.28 KB

SignaturesApi.md

File metadata and controls

307 lines (195 loc) · 8.28 KB

postiz_python_client.SignaturesApi

All URIs are relative to http://localhost

Method HTTP request Description
signature_controller_create_signature POST /signatures
signature_controller_delete_signature DELETE /signatures/{id}
signature_controller_get_default_signature GET /signatures/default
signature_controller_get_signatures GET /signatures
signature_controller_update_signature PUT /signatures/{id}

signature_controller_create_signature

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

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

signature_controller_delete_signature

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

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

signature_controller_get_default_signature

signature_controller_get_default_signature()

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

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

signature_controller_get_signatures

signature_controller_get_signatures()

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

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

signature_controller_update_signature

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

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