tickforge-client

An API to interact with Uptick Internal Resources

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.7.0
• Build package: org.openapitools.codegen.languages.PythonPydanticV1ClientCodegen

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

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 tickforge_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 tickforge_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import time
import tickforge_client
from tickforge_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://tickforge.onuptick.com
# See configuration.py for a list of all supported configuration parameters.
configuration = tickforge_client.Configuration(
    host = "https://tickforge.onuptick.com"
)



# Enter a context with an instance of the API client
with tickforge_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = tickforge_client.AuthApi(api_client)
    code = 'code_example' # str | 
    state = 'state_example' # str | 

    try:
        # Cognito Callback
        api_response = api_instance.cognito_callback_api_auth_cognito_callback_get(code, state)
        print("The response of AuthApi->cognito_callback_api_auth_cognito_callback_get:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AuthApi->cognito_callback_api_auth_cognito_callback_get: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://tickforge.onuptick.com

Documentation For Models

• AlwaysActive
• Backup
• BaseUser
• BatchId
• BodyBumpApiWorkspacesBumpPost
• BodyBumpAppApiWorkspacesAppNameBumpPost
• BodyQadeployApiWorkspacesQadeployPost
• BodyQadestroyApiWorkspacesQadestroyPost
• Branch
• BuildSchema
• Cluster
• CodeMetricBlobPayload
• CodeMetricBlobResponse
• CopyDBPayload
• CreateBackupResponse
• CreateBuildPayload
• CreateMetricPayload
• CreateWorkspacePayload
• Deleted
• DisplayName
• Email
• Error
• FirstName
• HTTPValidationError
• Image32
• IsAdmin
• IsAppUser
• IsBot
• IsEmailConfirmed
• IsOwner
• IsPrimaryOwner
• IsRestricted
• Job
• JobStatus
• LastName
• Limit
• ListUserResponse
• Metric
• MetricName
• Namespace
• Offset
• Profile
• RealName
• ResponseMetadata
• ServerTimezone
• ServerType
• Size
• SlackMember
• Team
• TeamId
• Title
• TokenResponse
• Tz
• TzLabel
• TzOffset
• Updated
• ValidationError
• ValidationErrorLocInner
• VersionsConfig
• Workspace
• WorkspaceCluster
• XHubSignature256

Documentation For Authorization

Authentication schemes defined for the API:

HTTPBearer

• Type: Bearer authentication

Author