Git Product home page Git Product logo

tgs-python-client's Introduction

swagger-client

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

This Python package is automatically generated by the Swagger Codegen project:

  • API version: 6.4.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import swagger_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import swagger_client

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.AdministrationApi(swagger_client.ApiClient(configuration))
api = 'api_example' # str | The API version being used in the form \"Tgstation.Server.Api/[API version]\"
user_agent = 'user_agent_example' # str | The user agent of the calling client.

try:
    # Attempts to restart the server.
    api_instance.administration_controller_delete(api, user_agent)
except ApiException as e:
    print("Exception when calling AdministrationApi->administration_controller_delete: %s\n" % e)


# create an instance of the API class
api_instance = swagger_client.AdministrationApi(swagger_client.ApiClient(configuration))
api = 'api_example' # str | The API version being used in the form \"Tgstation.Server.Api/[API version]\"
user_agent = 'user_agent_example' # str | The user agent of the calling client.

try:
    # Get Tgstation.Server.Api.Models.Administration server information.
    api_response = api_instance.administration_controller_read(api, user_agent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdministrationApi->administration_controller_read: %s\n" % e)


# create an instance of the API class
api_instance = swagger_client.AdministrationApi(swagger_client.ApiClient(configuration))
api = 'api_example' # str | The API version being used in the form \"Tgstation.Server.Api/[API version]\"
user_agent = 'user_agent_example' # str | The user agent of the calling client.
body = swagger_client.Administration() # Administration | The model containing the Tgstation.Server.Api.Models.Administration.NewVersion to update to. (optional)

try:
    # Attempt to perform a server upgrade.
    api_response = api_instance.administration_controller_update(api, user_agent, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdministrationApi->administration_controller_update: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to /

Class Method HTTP request Description
AdministrationApi administration_controller_delete DELETE /Administration Attempts to restart the server.
AdministrationApi administration_controller_read GET /Administration Get Tgstation.Server.Api.Models.Administration server information.
AdministrationApi administration_controller_update POST /Administration Attempt to perform a server upgrade.
ByondApi byond_controller_list GET /Byond/List Lists installed Tgstation.Server.Api.Models.Byond versions.
ByondApi byond_controller_read GET /Byond Gets the active Tgstation.Server.Api.Models.Byond version.
ByondApi byond_controller_update POST /Byond Changes the active BYOND version to the one specified in a given model.
ChatApi chat_controller_create PUT /Chat Create a new chat bot model.
ChatApi chat_controller_delete DELETE /Chat/{id} Delete a Tgstation.Server.Api.Models.ChatBot.
ChatApi chat_controller_get_id GET /Chat/{id} Get a specific Tgstation.Server.Api.Models.ChatBot.
ChatApi chat_controller_list GET /Chat/List List Tgstation.Server.Api.Models.ChatBots.
ChatApi chat_controller_update POST /Chat Updates a chat bot model.
ConfigurationApi configuration_controller_create PUT /Config Create a configuration directory.
ConfigurationApi configuration_controller_delete DELETE /Config Deletes an empty directory
ConfigurationApi configuration_controller_directory GET /Config/List/{directoryPath} Get the contents of a directory at a directoryPath
ConfigurationApi configuration_controller_file GET /Config/File/{filePath} Get the contents of a file at a filePath
ConfigurationApi configuration_controller_list GET /Config/List Get the contents of the root configuration directory.
ConfigurationApi configuration_controller_update POST /Config Write to a configuration file.
DreamDaemonApi dream_daemon_controller_create PUT /DreamDaemon Launches the watchdog.
DreamDaemonApi dream_daemon_controller_delete DELETE /DreamDaemon Stops the Watchdog if it's running.
DreamDaemonApi dream_daemon_controller_read GET /DreamDaemon Get the watchdog status.
DreamDaemonApi dream_daemon_controller_restart PATCH /DreamDaemon Creates a Tgstation.Server.Api.Models.Job to restart the Watchdog. It will start if it wasn't already running.
DreamDaemonApi dream_daemon_controller_update POST /DreamDaemon Update watchdog settings to be applied at next server reboot.
DreamMakerApi dream_maker_controller_create PUT /DreamMaker Begin deploying repository code.
DreamMakerApi dream_maker_controller_get_id GET /DreamMaker/{id} Get a Tgstation.Server.Api.Models.CompileJob specified by a given id.
DreamMakerApi dream_maker_controller_list GET /DreamMaker/List List all Tgstation.Server.Api.Models.CompileJobTgstation.Server.Api.Models.EntityIds for the instance.
DreamMakerApi dream_maker_controller_read GET /DreamMaker Read current Tgstation.Server.Api.Models.DreamMaker status.
DreamMakerApi dream_maker_controller_update POST /DreamMaker Update deployment settings.
HomeApi home_controller_create_token POST / Attempt to authenticate a Tgstation.Server.Host.Models.User using Tgstation.Server.Host.Controllers.ApiController.ApiHeaders
HomeApi home_controller_home GET / Main page of the Tgstation.Server.Host.Core.Application
InstanceApi instance_controller_create PUT /Instance Create or attach an Tgstation.Server.Api.Models.Instance.
InstanceApi instance_controller_delete DELETE /Instance/{id} Detach an Tgstation.Server.Api.Models.Instance with the given id.
InstanceApi instance_controller_get_id GET /Instance/{id} Get a specific Tgstation.Server.Api.Models.Instance.
InstanceApi instance_controller_list GET /Instance/List List Tgstation.Server.Api.Models.Instances.
InstanceApi instance_controller_update POST /Instance Modify an Tgstation.Server.Api.Models.Instance's settings.
InstanceUserApi instance_user_controller_create PUT /InstanceUser Create am Tgstation.Server.Api.Models.InstanceUser.
InstanceUserApi instance_user_controller_delete DELETE /InstanceUser/{id} Delete an Tgstation.Server.Api.Models.InstanceUser.
InstanceUserApi instance_user_controller_get_id GET /InstanceUser/{id} Gets a specific Tgstation.Server.Api.Models.InstanceUser.
InstanceUserApi instance_user_controller_list GET /InstanceUser/List Lists Tgstation.Server.Api.Models.InstanceUsers for the instance.
InstanceUserApi instance_user_controller_read GET /InstanceUser Read the active Tgstation.Server.Api.Models.InstanceUser.
InstanceUserApi instance_user_controller_update POST /InstanceUser Update the permissions for an Tgstation.Server.Api.Models.InstanceUser.
JobApi job_controller_delete DELETE /Job/{id} Cancel a running Tgstation.Server.Api.Models.Job.
JobApi job_controller_get_id GET /Job/{id} Get a specific Tgstation.Server.Api.Models.Job.
JobApi job_controller_list GET /Job/List List all Tgstation.Server.Api.Models.JobTgstation.Server.Api.Models.EntityIds for the instance in reverse creation order.
JobApi job_controller_read GET /Job Get active Tgstation.Server.Api.Models.Jobs for the instance.
RepositoryApi repository_controller_create PUT /Repository Begin cloning the repository if it doesn't exist.
RepositoryApi repository_controller_delete DELETE /Repository Delete the Tgstation.Server.Api.Models.Repository.
RepositoryApi repository_controller_read GET /Repository Get Tgstation.Server.Api.Models.Repository status.
RepositoryApi repository_controller_update POST /Repository Perform updats to the Tgstation.Server.Api.Models.Repository.
UserApi user_controller_create PUT /User Create a Tgstation.Server.Api.Models.User.
UserApi user_controller_get_id GET /User/{id} Get a specific Tgstation.Server.Api.Models.User.
UserApi user_controller_list GET /User/List List all Tgstation.Server.Api.Models.Users in the server.
UserApi user_controller_read GET /User Get information about the current Tgstation.Server.Api.Models.User.
UserApi user_controller_update POST /User Update a Tgstation.Server.Api.Models.User.

Documentation For Models

Documentation For Authorization

Password_Login_Scheme

  • Type: HTTP basic authentication

Token_Authorization_Scheme

Author

tgs-python-client's People

Contributors

optimumtact avatar

Watchers

avatar avatar avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.