Skip to content

Commit 0538540

Browse files
authored
Upgrade to openapi v3 and update 2019.10 spec (#5)
Upgrade to openapi v3 and update 2019.10 spec
1 parent a0fc30c commit 0538540

102 files changed

Lines changed: 1906 additions & 3174 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.

.github/workflows/ci.yml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: CI
2+
3+
on: [push]
4+
5+
jobs:
6+
build:
7+
8+
runs-on: ubuntu-latest
9+
10+
steps:
11+
- uses: actions/checkout@v1
12+
13+
- name: Set up Python 3.8
14+
uses: actions/setup-python@v1
15+
with:
16+
python-version: 3.8
17+
18+
- name: Install dependencies
19+
run: |
20+
python -m pip install --upgrade pip
21+
pip install -r requirements.txt
22+
pip install -r test-requirements.txt
23+
24+
- name: Test with nosetests
25+
run: |
26+
nosetests
27+
env:
28+
DYSPATCH_API_KEY: ${{ secrets.DYSPATCH_API_KEY }}

README.md

Lines changed: 14 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ details on how to implement Dyspatch.
1111
This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
1212

1313
- API version: 2019.10
14-
- Package version: 3.0.1
14+
- Package version: 4.0.0
1515
- Build package: io.swagger.codegen.languages.PythonClientCodegen
1616
For more information, please visit [https://docs.dyspatch.io](https://docs.dyspatch.io)
1717

@@ -28,7 +28,7 @@ pip install dyspatch-python
2828

2929
Then import the package:
3030
```python
31-
import dyspatch_client
31+
import dyspatch_client
3232
```
3333

3434
### Setuptools
@@ -82,48 +82,34 @@ All URIs are relative to *https://api.dyspatch.io*
8282

8383
Class | Method | HTTP request | Description
8484
------------ | ------------- | ------------- | -------------
85-
*DraftsApi* | [**drafts_draft_id_get**](docs/DraftsApi.md#drafts_draft_id_get) | **GET** /drafts/{draftId} | Get Draft by ID
86-
*DraftsApi* | [**drafts_draft_id_localization_keys_get**](docs/DraftsApi.md#drafts_draft_id_localization_keys_get) | **GET** /drafts/{draftId}/localizationKeys | Get Localization Keys
87-
*DraftsApi* | [**drafts_draft_id_localizations_get**](docs/DraftsApi.md#drafts_draft_id_localizations_get) | **GET** /drafts/{draftId}/localizations | Get Localizations on a Draft
88-
*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
89-
*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
90-
*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
91-
*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
92-
*DraftsApi* | [**drafts_get**](docs/DraftsApi.md#drafts_get) | **GET** /drafts | List Drafts
93-
*LocalizationsApi* | [**localizations_localization_id_get**](docs/LocalizationsApi.md#localizations_localization_id_get) | **GET** /localizations/{localizationId} | Get Localization Object by ID
94-
*TemplatesApi* | [**templates_get**](docs/TemplatesApi.md#templates_get) | **GET** /templates | List Templates
95-
*TemplatesApi* | [**templates_template_id_get**](docs/TemplatesApi.md#templates_template_id_get) | **GET** /templates/{templateId} | Get Template by ID
85+
*DraftsApi* | [**delete_localization**](docs/DraftsApi.md#delete_localization) | **DELETE** /drafts/{draftId}/localizations/{languageId} | Remove a localization
86+
*DraftsApi* | [**get_draft_by_id**](docs/DraftsApi.md#get_draft_by_id) | **GET** /drafts/{draftId} | Get Draft by ID
87+
*DraftsApi* | [**get_draft_localization_keys**](docs/DraftsApi.md#get_draft_localization_keys) | **GET** /drafts/{draftId}/localizationKeys | Get localization keys
88+
*DraftsApi* | [**get_drafts**](docs/DraftsApi.md#get_drafts) | **GET** /drafts | List Drafts
89+
*DraftsApi* | [**get_localization_for_draft**](docs/DraftsApi.md#get_localization_for_draft) | **GET** /drafts/{draftId}/localizations | Get localizations on a draft
90+
*DraftsApi* | [**save_localization**](docs/DraftsApi.md#save_localization) | **PUT** /drafts/{draftId}/localizations/{languageId} | Create or update a localization
91+
*DraftsApi* | [**set_translation**](docs/DraftsApi.md#set_translation) | **PUT** /drafts/{draftId}/localizations/{languageId}/translations | Set translations for language
92+
*DraftsApi* | [**submit_draft_for_approval**](docs/DraftsApi.md#submit_draft_for_approval) | **POST** /drafts/{draftId}/publishRequest | Submit the draft for approval
93+
*LocalizationsApi* | [**get_localization_by_id**](docs/LocalizationsApi.md#get_localization_by_id) | **GET** /localizations/{localizationId} | Get Localization Object by ID
94+
*TemplatesApi* | [**get_template_by_id**](docs/TemplatesApi.md#get_template_by_id) | **GET** /templates/{templateId} | Get Template by ID
95+
*TemplatesApi* | [**get_templates**](docs/TemplatesApi.md#get_templates) | **GET** /templates | List Templates
9696

9797

9898
## Documentation For Models
9999

100100
- [APIError](docs/APIError.md)
101-
- [Body](docs/Body.md)
102101
- [CompiledRead](docs/CompiledRead.md)
103-
- [CreatedAt](docs/CreatedAt.md)
104102
- [Cursor](docs/Cursor.md)
105-
- [DraftDescription](docs/DraftDescription.md)
106-
- [DraftId](docs/DraftId.md)
107103
- [DraftMetaRead](docs/DraftMetaRead.md)
108-
- [DraftName](docs/DraftName.md)
109104
- [DraftRead](docs/DraftRead.md)
110-
- [DraftUrl](docs/DraftUrl.md)
111105
- [DraftsRead](docs/DraftsRead.md)
112-
- [LanguageId](docs/LanguageId.md)
113-
- [LocalizationId](docs/LocalizationId.md)
106+
- [InlineObject](docs/InlineObject.md)
114107
- [LocalizationKeyRead](docs/LocalizationKeyRead.md)
115108
- [LocalizationMetaRead](docs/LocalizationMetaRead.md)
116-
- [LocalizationName](docs/LocalizationName.md)
117109
- [LocalizationRead](docs/LocalizationRead.md)
118-
- [LocalizationUrl](docs/LocalizationUrl.md)
119-
- [TemplateDescription](docs/TemplateDescription.md)
120-
- [TemplateId](docs/TemplateId.md)
121110
- [TemplateMetaRead](docs/TemplateMetaRead.md)
122-
- [TemplateName](docs/TemplateName.md)
123111
- [TemplateRead](docs/TemplateRead.md)
124-
- [TemplateUrl](docs/TemplateUrl.md)
125112
- [TemplatesRead](docs/TemplatesRead.md)
126-
- [UpdatedAt](docs/UpdatedAt.md)
127113

128114

129115
## Documentation For Authorization
@@ -139,4 +125,3 @@ Class | Method | HTTP request | Description
139125
## Author
140126

141127
support@dyspatch.io
142-

docs/APIError.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
# APIError
22

3+
possible errors from the api
34
## Properties
45
Name | Type | Description | Notes
56
------------ | ------------- | ------------- | -------------
6-
**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]
7+
**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. * prohibited_action - The request was refused because an action was not valid for the requested resource. Typically this will happen if you try to make changes to a locked resource. | [optional]
78
**message** | **str** | Human readable error message | [optional]
89
**parameter** | **str** | The invalid parameter, if 'code' is invalid_parameter | [optional]
910

docs/CompiledRead.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# CompiledRead
22

3+
revision data
34
## Properties
45
Name | Type | Description | Notes
56
------------ | ------------- | ------------- | -------------

docs/CreatedAt.md

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

docs/Cursor.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# Cursor
22

3+
Information about paginated results
34
## Properties
45
Name | Type | Description | Notes
56
------------ | ------------- | ------------- | -------------

docs/DraftDescription.md

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

docs/DraftId.md

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

docs/DraftMetaRead.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# DraftMetaRead
22

3+
draft metadata
34
## Properties
45
Name | Type | Description | Notes
56
------------ | ------------- | ------------- | -------------

docs/DraftName.md

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

0 commit comments

Comments
 (0)