Skip to content

SettingsApi.md

Latest commit

 

History

History
604 lines (384 loc) · 16.3 KB

SettingsApi.md

File metadata and controls

604 lines (384 loc) · 16.3 KB

postiz_python_client.SettingsApi

All URIs are relative to http://localhost

Method HTTP request Description
settings_controller_add_git_hub POST /settings/github
settings_controller_auth_url GET /settings/github/url
settings_controller_delete_repository DELETE /settings/repository/{id}
settings_controller_delete_team_member DELETE /settings/team/{id}
settings_controller_get_connected_github_accounts GET /settings/github
settings_controller_get_organizations GET /settings/organizations/{id}
settings_controller_get_repositories GET /settings/organizations/{id}/{github}
settings_controller_get_team GET /settings/team
settings_controller_invite_team_member POST /settings/team
settings_controller_update_git_hub_login POST /settings/organizations/{id}

settings_controller_add_git_hub

settings_controller_add_git_hub()

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

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

settings_controller_auth_url

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

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

settings_controller_delete_repository

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

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

settings_controller_delete_team_member

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

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

settings_controller_get_connected_github_accounts

settings_controller_get_connected_github_accounts()

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

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

settings_controller_get_organizations

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

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

settings_controller_get_repositories

settings_controller_get_repositories(id, github)

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.SettingsApi(api_client)
    id = 'id_example' # str | 
    github = 'github_example' # str | 

    try:
        api_instance.settings_controller_get_repositories(id, github)
    except Exception as e:
        print("Exception when calling SettingsApi->settings_controller_get_repositories: %s\n" % e)

Parameters

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

settings_controller_get_team

settings_controller_get_team()

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

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

settings_controller_invite_team_member

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

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

settings_controller_update_git_hub_login

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

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

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