Skip to content

Commit a94c78d

Browse files
authored
V2019.10 (#3)
* Update to the latest version of the Dyspatch API * Update README
1 parent a87ce89 commit a94c78d

100 files changed

Lines changed: 4904 additions & 176 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.travis.yml

Lines changed: 0 additions & 14 deletions
This file was deleted.

README.md

Lines changed: 52 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,18 @@
11
# Dyspatch Python Client
2-
# Introduction
3-
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.
4-
## API Client Libraries
5-
Dyspatch provides API Clients for popular languages and web frameworks.
6-
- [Java](https://github.com/getdyspatch/dyspatch-java)
7-
- [Javascript](https://github.com/getdyspatch/dyspatch-javascript)
8-
- [Python](https://github.com/getdyspatch/dyspatch-python)
9-
- [C#](https://github.com/getdyspatch/dyspatch-dotnet)
10-
- [Go](https://github.com/getdyspatch/dyspatch-golang)
11-
- [Ruby](https://github.com/getdyspatch/dyspatch-ruby)
2+
# Introduction
3+
The Dyspatch API is based on the REST paradigm and features resource based URLs
4+
with standard HTTP response codes to indicate errors.
5+
6+
We use standard HTTP authentication and request verbs and all responses are
7+
JSON formatted. See our [Implementation
8+
Guide](https://docs.dyspatch.io/development/implementing_dyspatch/) for more
9+
details on how to implement Dyspatch.
1210

1311
This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
1412

15-
- API version: 2019.03
16-
- Package version: 2.0.0
17-
- Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen
13+
- API version: 2019.10
14+
- Package version: 3.0.0
15+
- Build package: io.swagger.codegen.languages.PythonClientCodegen
1816
For more information, please visit [https://docs.dyspatch.io](https://docs.dyspatch.io)
1917

2018
## Requirements.
@@ -63,41 +61,73 @@ from pprint import pprint
6361

6462
# Configure API key authorization: Bearer
6563
configuration = dyspatch_client.Configuration()
66-
configuration.api_key['Authorization'] = 'Dyspatch_API_key'
67-
configuration.api_key_prefix['Authorization'] = 'Bearer'
64+
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
65+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
66+
# configuration.api_key_prefix['Authorization'] = 'Bearer'
6867

6968
# create an instance of the API class
70-
api_instance = dyspatch_client.TemplatesApi(dyspatch_client.ApiClient(configuration))
71-
cursor = 'example_cursor' # str | A cursor value used to retrieve a specific page from a paginated result set. (optional)
69+
api_instance = dyspatch_client.DraftsApi(dyspatch_client.ApiClient(configuration))
70+
draft_id = 'draft_id_example' # str | A draft ID
71+
target_language = 'target_language_example' # str | The type of templating language to compile as. Should only be used for visual templates.
7272

7373
try:
74-
# List Templates
75-
api_response = api_instance.templates_get(cursor=cursor)
74+
# Get Draft by ID
75+
api_response = api_instance.drafts_draft_id_get(draft_id, target_language)
7676
pprint(api_response)
7777
except ApiException as e:
78-
print("Exception when calling TemplatesApi->templates_get: %s\n" % e)
78+
print("Exception when calling DraftsApi->drafts_draft_id_get: %s\n" % e)
79+
7980
```
8081

8182
## Documentation for API Endpoints
8283

83-
All URIs are relative to *https://api.dyspatch.io/*
84+
All URIs are relative to *https://api.dyspatch.io*
8485

8586
Class | Method | HTTP request | Description
8687
------------ | ------------- | ------------- | -------------
88+
*DraftsApi* | [**drafts_draft_id_get**](docs/DraftsApi.md#drafts_draft_id_get) | **GET** /drafts/{draftId} | Get Draft by ID
89+
*DraftsApi* | [**drafts_draft_id_localization_keys_get**](docs/DraftsApi.md#drafts_draft_id_localization_keys_get) | **GET** /drafts/{draftId}/localizationKeys | Get Localization Keys
90+
*DraftsApi* | [**drafts_draft_id_localizations_get**](docs/DraftsApi.md#drafts_draft_id_localizations_get) | **GET** /drafts/{draftId}/localizations | Get Localizations on a Draft
91+
*DraftsApi* | [**drafts_draft_id_localizations_language_id_delete**](docs/DraftsApi.md#drafts_draft_id_localizations_language_id_delete) | **DELETE** /drafts/{draftId}/localizations/{languageId} | Remove a Localization
92+
*DraftsApi* | [**drafts_draft_id_localizations_language_id_put**](docs/DraftsApi.md#drafts_draft_id_localizations_language_id_put) | **PUT** /drafts/{draftId}/localizations/{languageId} | Create or Update a Localization
93+
*DraftsApi* | [**drafts_draft_id_localizations_language_id_translations_put**](docs/DraftsApi.md#drafts_draft_id_localizations_language_id_translations_put) | **PUT** /drafts/{draftId}/localizations/{languageId}/translations | Set Translations for Language
94+
*DraftsApi* | [**drafts_draft_id_publish_request_post**](docs/DraftsApi.md#drafts_draft_id_publish_request_post) | **POST** /drafts/{draftId}/publishRequest | Submit the Draft for Approval
95+
*DraftsApi* | [**drafts_get**](docs/DraftsApi.md#drafts_get) | **GET** /drafts | List Drafts
8796
*LocalizationsApi* | [**localizations_localization_id_get**](docs/LocalizationsApi.md#localizations_localization_id_get) | **GET** /localizations/{localizationId} | Get Localization Object by ID
8897
*TemplatesApi* | [**templates_get**](docs/TemplatesApi.md#templates_get) | **GET** /templates | List Templates
8998
*TemplatesApi* | [**templates_template_id_get**](docs/TemplatesApi.md#templates_template_id_get) | **GET** /templates/{templateId} | Get Template by ID
9099

100+
91101
## Documentation For Models
92102

93103
- [APIError](docs/APIError.md)
104+
- [Body](docs/Body.md)
94105
- [CompiledRead](docs/CompiledRead.md)
106+
- [CreatedAt](docs/CreatedAt.md)
95107
- [Cursor](docs/Cursor.md)
108+
- [DraftDescription](docs/DraftDescription.md)
109+
- [DraftId](docs/DraftId.md)
110+
- [DraftMetaRead](docs/DraftMetaRead.md)
111+
- [DraftName](docs/DraftName.md)
112+
- [DraftRead](docs/DraftRead.md)
113+
- [DraftUrl](docs/DraftUrl.md)
114+
- [DraftsRead](docs/DraftsRead.md)
115+
- [LanguageId](docs/LanguageId.md)
116+
- [LocalizationId](docs/LocalizationId.md)
117+
- [LocalizationKeyRead](docs/LocalizationKeyRead.md)
96118
- [LocalizationMetaRead](docs/LocalizationMetaRead.md)
119+
- [LocalizationName](docs/LocalizationName.md)
97120
- [LocalizationRead](docs/LocalizationRead.md)
121+
- [LocalizationUrl](docs/LocalizationUrl.md)
122+
- [TemplateDescription](docs/TemplateDescription.md)
123+
- [TemplateId](docs/TemplateId.md)
98124
- [TemplateMetaRead](docs/TemplateMetaRead.md)
125+
- [TemplateName](docs/TemplateName.md)
99126
- [TemplateRead](docs/TemplateRead.md)
127+
- [TemplateUrl](docs/TemplateUrl.md)
100128
- [TemplatesRead](docs/TemplatesRead.md)
129+
- [UpdatedAt](docs/UpdatedAt.md)
130+
101131

102132
## Documentation For Authorization
103133

@@ -112,3 +142,4 @@ Class | Method | HTTP request | Description
112142
## Author
113143

114144
support@dyspatch.io
145+

docs/APIError.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@ Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**code** | **str** | Error code: * server_error - Internal server error. * invalid_parameter - Validation error, parameter will contain invalid field and message will contain the reason. * invalid_body - Body could not be parsed, message will contain the reason. * invalid_request - Validation error, the protocol used to make the request was not https. * unauthorized - Credentials were found but permissions were not sufficient. * unauthenticated - Credentials were not found or were not valid. * not_found - The requested resource was not found. * rate_limited - The request was refused because a rate limit was exceeded. There is an account wide rate limit of 3600 requests per-minute, although that is subject to change. The current remaining rate limit can be viewed by checking the X-Ratelimit-Remaining header. | [optional]
77
**message** | **str** | Human readable error message | [optional]
8-
**parameter** | **str** | The invalid parameter, if 'code' is invalid_parameter | [optional]
8+
**parameter** | **str** | The invalid parameter, if 'code' is invalid_parameter | [optional]
99

1010
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1111

12+

docs/Body.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Body
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**name** | **str** | | [optional]
7+
8+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
9+
10+

docs/CompiledRead.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,4 @@ Name | Type | Description | Notes
1111

1212
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1313

14+

docs/CreatedAt.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# CreatedAt
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
7+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
8+
9+

docs/Cursor.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,4 @@ Name | Type | Description | Notes
88

99
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1010

11+

docs/DraftDescription.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# DraftDescription
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
7+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
8+
9+

docs/DraftId.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# DraftId
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
7+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
8+
9+

docs/DraftMetaRead.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# DraftMetaRead
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**id** | **str** | An opaque, unique identifier for a draft | [optional]
7+
**template_id** | **str** | An opaque, unique identifier for a template | [optional]
8+
**name** | **str** | The name of a draft | [optional]
9+
**description** | **str** | A description of the draft | [optional]
10+
**url** | **str** | The API url for a specific draft | [optional]
11+
**created_at** | **datetime** | The time of initial creation | [optional]
12+
**updated_at** | **datetime** | The time of last update | [optional]
13+
14+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
15+
16+

0 commit comments

Comments
 (0)