Skip to content

merge-api/merge-ticketing-python

BranchesTags

Repository files navigation

Deprecation Notice

Merge has released a new version of our Python SDK. As part of that release, we are providing a deprecation notice of our legacy SDKs.

To help give you time to plan your migration to our latest SDK:

  • August 2023: SDK deprecation notice on our legacy Python SDKs.
  • Until February 2024: we’ll support updates as needed and address bugs in priority order
  • After February 2024: we’ll no longer make updates or bug fixes to the deprecated SDKs

For information about the deprecation notice see our help center and for information about migrating to the Python SDK, see the Python Migration Guide.

MergeTicketingClient

The unified API for building rich integrations with multiple Ticketing platforms.

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

  • API version: 1.0
  • Package version: 1.1.2
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://www.merge.dev/

Requirements.

Python >= 3.6

Installation & Usage

pip install

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

pip install git+https://github.com/merge-api/merge-ticketing-python.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/merge-api/merge-ticketing-python.git)

Then import the package:

import MergeTicketingClient

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 MergeTicketingClient

Getting Started

Please follow the installation procedure and then run the following:

import time
import MergeTicketingClient
from pprint import pprint
from MergeTicketingClient.api import account_details_api
from MergeTicketingClient.model.account_details import AccountDetails
# Defining the host is optional and defaults to https://api.merge.dev/api/ticketing/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = MergeTicketingClient.Configuration(
    host = "https://api.merge.dev/api/ticketing/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'


# Enter a context with an instance of the API client
with MergeTicketingClient.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = account_details_api.AccountDetailsApi(api_client)
    x_account_token = "X-Account-Token_example" # str | Token identifying the end user.

    try:
        api_response = api_instance.account_details_retrieve(x_account_token)
        pprint(api_response)
    except MergeTicketingClient.ApiException as e:
        print("Exception when calling AccountDetailsApi->account_details_retrieve: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.merge.dev/api/ticketing/v1

Class Method HTTP request Description
AccountDetailsApi account_details_retrieve GET /account-details
AccountTokenApi account_token_retrieve GET /account-token/{public_token}
AccountsApi accounts_list GET /accounts
AccountsApi accounts_retrieve GET /accounts/{id}
AttachmentsApi attachments_create POST /attachments
AttachmentsApi attachments_list GET /attachments
AttachmentsApi attachments_meta_post_retrieve GET /attachments/meta/post
AttachmentsApi attachments_retrieve GET /attachments/{id}
AvailableActionsApi available_actions_retrieve GET /available-actions
CollectionsApi collections_list GET /collections
CollectionsApi collections_retrieve GET /collections/{id}
CommentsApi comments_create POST /comments
CommentsApi comments_list GET /comments
CommentsApi comments_meta_post_retrieve GET /comments/meta/post
CommentsApi comments_retrieve GET /comments/{id}
ContactsApi contacts_list GET /contacts
ContactsApi contacts_retrieve GET /contacts/{id}
DeleteAccountApi delete_account_create POST /delete-account
ForceResyncApi sync_status_resync_create POST /sync-status/resync
GenerateKeyApi generate_key_create POST /generate-key
IssuesApi issues_list GET /issues
IssuesApi issues_retrieve GET /issues/{id}
LinkTokenApi link_token_create POST /link-token
LinkedAccountsApi linked_accounts_list GET /linked-accounts
PassthroughApi passthrough_create POST /passthrough
ProjectsApi projects_list GET /projects
ProjectsApi projects_retrieve GET /projects/{id}
ProjectsApi projects_users_list GET /projects/{parent_id}/users
RegenerateKeyApi regenerate_key_create POST /regenerate-key
SelectiveSyncApi selective_sync_configurations_list GET /selective-sync/configurations
SelectiveSyncApi selective_sync_configurations_update PUT /selective-sync/configurations
SelectiveSyncApi selective_sync_meta_list GET /selective-sync/meta
SyncStatusApi sync_status_list GET /sync-status
TagsApi tags_list GET /tags
TagsApi tags_retrieve GET /tags/{id}
TeamsApi teams_list GET /teams
TeamsApi teams_retrieve GET /teams/{id}
TicketsApi tickets_collaborators_list GET /tickets/{parent_id}/collaborators
TicketsApi tickets_create POST /tickets
TicketsApi tickets_list GET /tickets
TicketsApi tickets_meta_patch_retrieve GET /tickets/meta/patch/{id}
TicketsApi tickets_meta_post_retrieve GET /tickets/meta/post
TicketsApi tickets_partial_update PATCH /tickets/{id}
TicketsApi tickets_retrieve GET /tickets/{id}
UsersApi users_list GET /users
UsersApi users_retrieve GET /users/{id}
WebhookReceiversApi webhook_receivers_create POST /webhook-receivers
WebhookReceiversApi webhook_receivers_list GET /webhook-receivers

Documentation For Models

Documentation For Authorization

tokenAuth

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Author

[email protected]

Notes for Large OpenAPI documents

If the OpenAPI document is large, imports in MergeTicketingClient.apis and MergeTicketingClient.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:

Solution 1: Use specific imports for apis and models like:

  • from MergeTicketingClient.api.default_api import DefaultApi
  • from MergeTicketingClient.model.pet import Pet

Solution 2: Before importing the package, adjust the maximum recursion limit as shown below:

import sys
sys.setrecursionlimit(1500)
import MergeTicketingClient
from MergeTicketingClient.apis import *
from MergeTicketingClient.models import *

About

The Python API Client for the Merge Ticketing API.

Resources

Readme

License

View license
Activity
Custom properties

Stars

0 stars

Watchers

10 watching

Forks

1 fork
Report repository

Releases

No releases published

Packages

No packages published

Contributors 5

Languages