Dyspatch API Client
Project description
Dyspatch Python Client
Introduction
The Dyspatch API is based on the REST paradigm and features resource based URLs with standard HTTP response codes to indicate errors.
We use standard HTTP authentication and request verbs and all responses are JSON formatted. See our Implementation Guide for more details on how to implement Dyspatch.
This Python package is automatically generated by the Swagger Codegen project:
- API version: 2019.10
- Package version: 3.0.0
- Build package: io.swagger.codegen.languages.PythonClientCodegen For more information, please visit https://docs.dyspatch.io
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 dyspatch_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 dyspatch_client
Getting Started
Please follow the installation procedure and then run the following:
from __future__ import print_function
import time
import dyspatch_client
from dyspatch_client.rest import ApiException
from pprint import pprint
# Configure API key authorization: Bearer
configuration = dyspatch_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'
# create an instance of the API class
api_instance = dyspatch_client.DraftsApi(dyspatch_client.ApiClient(configuration))
draft_id = 'draft_id_example' # str | A draft ID
target_language = 'target_language_example' # str | The type of templating language to compile as. Should only be used for visual templates.
try:
# Get Draft by ID
api_response = api_instance.drafts_draft_id_get(draft_id, target_language)
pprint(api_response)
except ApiException as e:
print("Exception when calling DraftsApi->drafts_draft_id_get: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to https://api.dyspatch.io
Class | Method | HTTP request | Description |
---|---|---|---|
DraftsApi | drafts_draft_id_get | GET /drafts/{draftId} | Get Draft by ID |
DraftsApi | drafts_draft_id_localization_keys_get | GET /drafts/{draftId}/localizationKeys | Get Localization Keys |
DraftsApi | drafts_draft_id_localizations_get | GET /drafts/{draftId}/localizations | Get Localizations on a Draft |
DraftsApi | drafts_draft_id_localizations_language_id_delete | DELETE /drafts/{draftId}/localizations/{languageId} | Remove a Localization |
DraftsApi | drafts_draft_id_localizations_language_id_put | PUT /drafts/{draftId}/localizations/{languageId} | Create or Update a Localization |
DraftsApi | drafts_draft_id_localizations_language_id_translations_put | PUT /drafts/{draftId}/localizations/{languageId}/translations | Set Translations for Language |
DraftsApi | drafts_draft_id_publish_request_post | POST /drafts/{draftId}/publishRequest | Submit the Draft for Approval |
DraftsApi | drafts_get | GET /drafts | List Drafts |
LocalizationsApi | localizations_localization_id_get | GET /localizations/{localizationId} | Get Localization Object by ID |
TemplatesApi | templates_get | GET /templates | List Templates |
TemplatesApi | templates_template_id_get | GET /templates/{templateId} | Get Template by ID |
Documentation For Models
- APIError
- Body
- CompiledRead
- CreatedAt
- Cursor
- DraftDescription
- DraftId
- DraftMetaRead
- DraftName
- DraftRead
- DraftUrl
- DraftsRead
- LanguageId
- LocalizationId
- LocalizationKeyRead
- LocalizationMetaRead
- LocalizationName
- LocalizationRead
- LocalizationUrl
- TemplateDescription
- TemplateId
- TemplateMetaRead
- TemplateName
- TemplateRead
- TemplateUrl
- TemplatesRead
- UpdatedAt
Documentation For Authorization
Bearer
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header
Author
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for dyspatch_python-3.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ba589dc3da840f0c3902311e62faa736f63ecf4c81696cb5943fe565f57ff094 |
|
MD5 | 5b978607f11370a4f4add237a5d28009 |
|
BLAKE2b-256 | 38629346766e3b6071cba070576ac3abbe131e4cbb13d3728995287f287ce417 |