tbs-sdk
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: 1.0
- Package version: 0.0.2
- Build package: io.swagger.codegen.languages.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 tbs_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 tbs_client
Getting Started
Please follow the installation procedure and then run the following:
from __future__ import print_function
import time
import tbs_client
from tbs_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = tbs_client.AuthApi()
jwt_data = tbs_client.JWTData() # JWTData | (optional)
try:
# Create JSON Web Token (JWT)
api_response = api_instance.auth_jwt_token_auth(jwt_data=jwt_data)
pprint(api_response)
except ApiException as e:
print("Exception when calling AuthApi->auth_jwt_token_auth: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to https://api.3blades.ai
Class | Method | HTTP request | Description |
---|---|---|---|
AuthApi | auth_jwt_token_auth | POST /auth/jwt-token-auth/ | Create JSON Web Token (JWT) |
AuthApi | auth_jwt_token_refresh | POST /auth/jwt-token-refresh/ | Refresh a JSON Web Token (JWT) |
AuthApi | auth_jwt_token_verify | POST /auth/jwt-token-verify/ | Validate JSON Web Token (JWT) |
AuthApi | auth_register | POST /auth/register/ | Register a user |
AuthApi | oauth_login | GET /auth/login/{provider}/ | |
BillingApi | billing_cards_create | POST /v1/{namespace}/billing/cards/ | Create new credit card |
BillingApi | billing_cards_delete | DELETE /v1/{namespace}/billing/cards/{id}/ | Delete a credit card |
BillingApi | billing_cards_list | GET /v1/{namespace}/billing/cards/ | Get credit cards |
BillingApi | billing_cards_read | GET /v1/{namespace}/billing/cards/{id}/ | Get credit card by id |
BillingApi | billing_cards_replace | PUT /v1/{namespace}/billing/cards/{id}/ | Replace a credit card |
BillingApi | billing_cards_update | PATCH /v1/{namespace}/billing/cards/{id}/ | Update a credit card |
BillingApi | billing_invoice_items_list | GET /v1/{namespace}/billing/invoices/{invoice_id}/invoice-items/ | Get invoice items for a given invoice. |
BillingApi | billing_invoice_items_read | GET /v1/{namespace}/billing/invoices/{invoice_id}/invoice-items/{id} | Get a specific InvoiceItem. |
BillingApi | billing_invoices_list | GET /v1/{namespace}/billing/invoices/ | Get invoices |
BillingApi | billing_invoices_read | GET /v1/{namespace}/billing/invoices/{id}/ | Get an invoice |
BillingApi | billing_plans_list | GET /v1/{namespace}/billing/plans/ | Get billing plans |
BillingApi | billing_plans_read | GET /v1/{namespace}/billing/plans/{id}/ | Get a billing plan |
BillingApi | billing_subscriptions_create | POST /v1/{namespace}/billing/subscriptions/ | Create a new subscription |
BillingApi | billing_subscriptions_delete | DELETE /v1/{namespace}/billing/subscriptions/{id}/ | Delete a subscription |
BillingApi | billing_subscriptions_list | GET /v1/{namespace}/billing/subscriptions/ | Get active subscriptons |
BillingApi | billing_subscriptions_read | GET /v1/{namespace}/billing/subscriptions/{id}/ | Get a subscriptions |
HostsApi | hosts_create | POST /v1/{namespace}/hosts/ | Create a new host |
HostsApi | hosts_delete | DELETE /v1/{namespace}/hosts/{host}/ | Delete a host |
HostsApi | hosts_list | GET /v1/{namespace}/hosts/ | Get available hosts |
HostsApi | hosts_read | GET /v1/{namespace}/hosts/{host}/ | Get a host |
HostsApi | hosts_replace | PUT /v1/{namespace}/hosts/{host}/ | Replace a host |
HostsApi | hosts_update | PATCH /v1/{namespace}/hosts/{host}/ | Update a host |
NotificationsApi | notification_read | GET /v1/{namespace}/notifications/{notification_id} | Retrieve a specific notification. |
NotificationsApi | notification_settings_create | POST /v1/{namespace}/notifications/settings/ | Create global notification settings |
NotificationsApi | notification_settings_entity_create | POST /v1/{namespace}/notifications/settings/entity/{entity} | Create global notification settings |
NotificationsApi | notification_settings_entity_read | GET /v1/{namespace}/notifications/settings/entity/{entity} | Retrieve global notification settings for the authenticated user |
NotificationsApi | notification_settings_entity_update | PATCH /v1/{namespace}/notifications/settings/entity/{entity} | Modify global notification settings. |
NotificationsApi | notification_settings_read | GET /v1/{namespace}/notifications/settings/ | Retrieve global notification settings for the authenticated user |
NotificationsApi | notification_settings_update | PATCH /v1/{namespace}/notifications/settings/ | Modify global notification settings. |
NotificationsApi | notification_update | PATCH /v1/{namespace}/notifications/{notification_id} | Mark a specific notification as either read or unread. |
NotificationsApi | notifications_list | GET /v1/{namespace}/notifications/ | Get notifications of all types and entities for the authenticated user. |
NotificationsApi | notifications_list_entity | GET /v1/{namespace}/notifications/entity/{entity} | Get notifications of all types and entities for the authenticated user. |
NotificationsApi | notifications_update_entity_list | PATCH /v1/{namespace}/notifications/entity/{entity} | Mark a list of notifications as either read or unread. |
NotificationsApi | notifications_update_list | PATCH /v1/{namespace}/notifications/ | Mark a list of notifications as either read or unread. |
ProjectsApi | project_copy | POST /v1/{namespace}/projects/project-copy/ | Copy a project to your own account. |
ProjectsApi | project_copy_check | HEAD /v1/{namespace}/projects/project-copy-check/ | Check if you are able to copy a project to your account. |
ProjectsApi | projects_collaborators_create | POST /v1/{namespace}/projects/{project}/collaborators/ | Create project collaborators |
ProjectsApi | projects_collaborators_delete | DELETE /v1/{namespace}/projects/{project}/collaborators/{collaborator}/ | Delete a project collaborator |
ProjectsApi | projects_collaborators_list | GET /v1/{namespace}/projects/{project}/collaborators/ | Get project collaborators |
ProjectsApi | projects_collaborators_read | GET /v1/{namespace}/projects/{project}/collaborators/{collaborator}/ | Get a project collaborator |
ProjectsApi | projects_collaborators_update | PATCH /v1/{namespace}/projects/{project}/collaborators/{collaborator}/ | Update project collaborator |
ProjectsApi | projects_create | POST /v1/{namespace}/projects/ | Create a new project |
ProjectsApi | projects_delete | DELETE /v1/{namespace}/projects/{project}/ | Delete a project |
ProjectsApi | projects_list | GET /v1/{namespace}/projects/ | Get available projects |
ProjectsApi | projects_project_files_create | POST /v1/{namespace}/projects/{project}/project_files/ | Create project files |
ProjectsApi | projects_project_files_delete | DELETE /v1/{namespace}/projects/{project}/project_files/{id}/ | Delete a project file |
ProjectsApi | projects_project_files_list | GET /v1/{namespace}/projects/{project}/project_files/ | Get project files |
ProjectsApi | projects_project_files_read | GET /v1/{namespace}/projects/{project}/project_files/{id}/ | Get a project file |
ProjectsApi | projects_project_files_replace | PUT /v1/{namespace}/projects/{project}/project_files/{id}/ | Replace a project file |
ProjectsApi | projects_project_files_update | PATCH /v1/{namespace}/projects/{project}/project_files/{id}/ | Update a project file |
ProjectsApi | projects_read | GET /v1/{namespace}/projects/{project}/ | Get a project |
ProjectsApi | projects_replace | PUT /v1/{namespace}/projects/{project}/ | Replace a project |
ProjectsApi | projects_servers_api_key | GET /v1/{namespace}/projects/{project}/servers/{server}/api-key/ | Get server API key |
ProjectsApi | projects_servers_auth | POST /v1/{namespace}/projects/{project}/servers/{server}/auth/ | Server api key validation |
ProjectsApi | projects_servers_create | POST /v1/{namespace}/projects/{project}/servers/ | Create a new server |
ProjectsApi | projects_servers_delete | DELETE /v1/{namespace}/projects/{project}/servers/{server}/ | Delete a server |
ProjectsApi | projects_servers_list | GET /v1/{namespace}/projects/{project}/servers/ | Retrieve servers |
ProjectsApi | projects_servers_read | GET /v1/{namespace}/projects/{project}/servers/{server}/ | Retrieve a server |
ProjectsApi | projects_servers_replace | PUT /v1/{namespace}/projects/{project}/servers/{server}/ | Replace a server |
ProjectsApi | projects_servers_run_stats_create | POST /v1/{namespace}/projects/{project}/servers/{server}/run-stats/ | Create a new server's run statistics |
ProjectsApi | projects_servers_run_stats_delete | DELETE /v1/{namespace}/projects/{project}/servers/{server}/run-stats/{id}/ | Delete a server's statistics |
ProjectsApi | projects_servers_run_stats_read | GET /v1/{namespace}/projects/{project}/servers/{server}/run-stats/{id}/ | Retrieve statistics for a server |
ProjectsApi | projects_servers_run_stats_replace | PUT /v1/{namespace}/projects/{project}/servers/{server}/run-stats/{id}/ | Replace a server's statistics |
ProjectsApi | projects_servers_run_stats_update | PATCH /v1/{namespace}/projects/{project}/servers/{server}/run-stats/{id}/ | Update a server's statistics |
ProjectsApi | projects_servers_ssh_tunnels_create | POST /v1/{namespace}/projects/{project}/servers/{server}/ssh-tunnels/ | Create SSH Tunnel associated to a server |
ProjectsApi | projects_servers_ssh_tunnels_delete | DELETE /v1/{namespace}/projects/{project}/servers/{server}/ssh-tunnels/{tunnel}/ | Delete an SSH Tunnel associated to a server |
ProjectsApi | projects_servers_ssh_tunnels_list | GET /v1/{namespace}/projects/{project}/servers/{server}/ssh-tunnels/ | Get SSH Tunnels associated to a server |
ProjectsApi | projects_servers_ssh_tunnels_read | GET /v1/{namespace}/projects/{project}/servers/{server}/ssh-tunnels/{tunnel}/ | Get an SSH Tunnel associated to a server |
ProjectsApi | projects_servers_ssh_tunnels_replace | PUT /v1/{namespace}/projects/{project}/servers/{server}/ssh-tunnels/{tunnel}/ | Replace SSH Tunnel associated to a server |
ProjectsApi | projects_servers_ssh_tunnels_update | PATCH /v1/{namespace}/projects/{project}/servers/{server}/ssh-tunnels/{tunnel}/ | Update an SSH Tunnel associated to a server |
ProjectsApi | projects_servers_start | POST /v1/{namespace}/projects/{project}/servers/{server}/start/ | Start a server |
ProjectsApi | projects_servers_stats_delete | DELETE /v1/{namespace}/projects/{project}/servers/{server}/stats/{id}/ | Delete a server's statistics |
ProjectsApi | projects_servers_stats_read | GET /v1/{namespace}/projects/{project}/servers/{server}/stats/{id}/ | Retrieve a server's statistics |
ProjectsApi | projects_servers_stats_replace | PUT /v1/{namespace}/projects/{project}/servers/{server}/stats/{id}/ | Replace a server's statistics |
ProjectsApi | projects_servers_stats_update | PATCH /v1/{namespace}/projects/{project}/servers/{server}/stats/{id}/ | Update a server's statistics |
ProjectsApi | projects_servers_stop | POST /v1/{namespace}/projects/{project}/servers/{server}/stop/ | Stop a server |
ProjectsApi | projects_servers_update | PATCH /v1/{namespace}/projects/{project}/servers/{server}/ | Update a server |
ProjectsApi | projects_update | PATCH /v1/{namespace}/projects/{project}/ | Update a project |
ProjectsApi | service_trigger_create | POST /v1/{namespace}/projects/{project}/servers/{server}/triggers/ | Create a new server trigger |
ProjectsApi | service_trigger_delete | DELETE /v1/{namespace}/projects/{project}/servers/{server}/triggers/{trigger}/ | Delete a server trigger |
ProjectsApi | service_trigger_list | GET /v1/{namespace}/projects/{project}/servers/{server}/triggers/ | Retrieve server triggers |
ProjectsApi | service_trigger_read | GET /v1/{namespace}/projects/{project}/servers/{server}/triggers/{trigger}/ | Get a server trigger |
ProjectsApi | service_trigger_replace | PUT /v1/{namespace}/projects/{project}/servers/{server}/triggers/{trigger}/ | Replace a server trigger |
ProjectsApi | service_trigger_update | PATCH /v1/{namespace}/projects/{project}/servers/{server}/triggers/{trigger}/ | Update a server trigger |
SearchApi | search | GET /v1/{namespace}/search/ | Get a search results |
ServersApi | servers_options_resources_read | GET /v1/servers/options/server-size/{size}/ | Get a server size by id |
ServersApi | servers_options_server_size_create | POST /v1/servers/options/server-size/ | Create a new server size item |
ServersApi | servers_options_server_size_delete | DELETE /v1/servers/options/server-size/{size}/ | Delete a server size by id |
ServersApi | servers_options_server_size_replace | PUT /v1/servers/options/server-size/{size}/ | Replace a server size by id |
ServersApi | servers_options_server_size_update | PATCH /v1/servers/options/server-size/{size}/ | Update a server size by id |
ServersApi | servers_options_sizes_list | GET /v1/servers/options/server-size/ | Retrieve available server sizes |
UsersApi | me | GET /v1/me | A convenience endpoint that is equivalent to GET /v1/users/profiles/<my user id>/ |
UsersApi | user_avatar_delete | DELETE /v1/users/{user}/avatar/ | Delete avatar |
UsersApi | user_avatar_get | GET /v1/users/{user}/avatar/ | Retrieve user's avatar |
UsersApi | user_avatar_set | POST /v1/users/{user}/avatar/ | Add user avatar |
UsersApi | user_avatar_update | PATCH /v1/users/{user}/avatar/ | Update a project file |
UsersApi | users_api_key_list | GET /v1/users/{user}/api-key/ | Retrieve account's API key |
UsersApi | users_api_key_reset | POST /v1/users/{user}/api-key/reset/ | Reset a user's API key |
UsersApi | users_create | POST /v1/users/profiles/ | Create new user |
UsersApi | users_delete | DELETE /v1/users/profiles/{user}/ | Delete a user |
UsersApi | users_emails_create | POST /v1/users/{user}/emails/ | Create an email address |
UsersApi | users_emails_delete | DELETE /v1/users/{user}/emails/{email_id}/ | Delete an email address |
UsersApi | users_emails_list | GET /v1/users/{user}/emails/ | Retrieve account email addresses |
UsersApi | users_emails_read | GET /v1/users/{user}/emails/{email_id}/ | Retrieve a user's email addresses |
UsersApi | users_emails_replace | PUT /v1/users/{user}/emails/{email_id}/ | Replace an email address |
UsersApi | users_emails_update | PATCH /v1/users/{user}/emails/{email_id}/ | Update an email address |
UsersApi | users_list | GET /v1/users/profiles/ | Get user list |
UsersApi | users_read | GET /v1/users/profiles/{user}/ | Retrieve a user |
UsersApi | users_ssh_key_list | GET /v1/users/{user}/ssh-key/ | Retrieve an SSH key |
UsersApi | users_ssh_key_reset | POST /v1/users/{user}/ssh-key/reset/ | Recreate an SSH key |
UsersApi | users_update | PATCH /v1/users/profiles/{user}/ | Update a user |
Documentation For Models
- Action
- AuthToken
- AuthTokenData
- AuthTokenError
- Card
- CardDataPost
- CardDataPutandPatch
- CardError
- CardUpdateError
- Collaborator
- CollaboratorData
- CollaboratorError
- Customer
- CustomerData
- CustomerError
- DockerHost
- DockerHostData
- DockerHostError
- EmailData
- EmailError
- Invoice
- InvoiceItem
- JWT
- JWTData
- JWTError
- NotFound
- Notification
- NotificationError
- NotificationListUpdateData
- NotificationSettings
- NotificationSettingsData
- NotificationSettingsError
- NotificationUpdateData
- Plan
- PlanData
- PlanError
- Project
- ProjectCopyData
- ProjectCopyData1
- ProjectData
- ProjectError
- ProjectFile
- ProjectFileError
- RefreshJSONWebToken
- RefreshJSONWebTokenData
- RefreshJSONWebTokenError
- Search
- Server
- ServerAction
- ServerActionData
- ServerActionError
- ServerConfig
- ServerData
- ServerError
- ServerRunStatistics
- ServerRunStatisticsData
- ServerRunStatisticsError
- ServerSize
- ServerSizeData
- ServerSizeError
- ServerStatistics
- ServerStatisticsData
- ServerStatisticsError
- SshTunnel
- SshTunnelData
- SshTunnelError
- Subscription
- SubscriptionData
- SubscriptionError
- User
- UserData
- UserError
- UserProfile
- UserProfileError
- VerifyJSONWebToken
- VerifyJSONWebTokenData
- VerifyJSONWebTokenError
- Webhook
Documentation For Authorization
jwt
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header