Skip to content

Commit b02edeb

Browse files
authored
Generate 2020.04 (#7)
* Generate 2020.04 * Updated package version and date * Setup.py point to README.md for long description * update integration test
1 parent 0538540 commit b02edeb

Some content is hidden

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

46 files changed

+294
-225
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ details on how to implement Dyspatch.
1010

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

13-
- API version: 2019.10
14-
- Package version: 4.0.0
13+
- API version: 2020.04
14+
- Package version: 5.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

docs/DraftsApi.md

Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ configuration.host = "https://api.dyspatch.io"
4242
api_instance = dyspatch_client.DraftsApi(dyspatch_client.ApiClient(configuration))
4343
draft_id = 'draft_id_example' # str | A draft ID
4444
language_id = 'language_id_example' # str | A language ID (eg: en-US)
45-
accept = 'accept_example' # str | A version of the API that should be used for the request. For example, to use version \"2019.10\", set the value to \"application/vnd.dyspatch.2019.10+json\"
45+
accept = 'accept_example' # str | A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\"
4646

4747
try:
4848
# Remove a localization
@@ -57,7 +57,7 @@ Name | Type | Description | Notes
5757
------------- | ------------- | ------------- | -------------
5858
**draft_id** | **str**| A draft ID |
5959
**language_id** | **str**| A language ID (eg: en-US) |
60-
**accept** | **str**| A version of the API that should be used for the request. For example, to use version \"2019.10\", set the value to \"application/vnd.dyspatch.2019.10+json\" |
60+
**accept** | **str**| A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\" |
6161

6262
### Return type
6363

@@ -107,7 +107,7 @@ configuration.host = "https://api.dyspatch.io"
107107
api_instance = dyspatch_client.DraftsApi(dyspatch_client.ApiClient(configuration))
108108
draft_id = 'draft_id_example' # str | A draft ID
109109
target_language = 'target_language_example' # str | The type of templating language to compile as. Should only be used for visual templates.
110-
accept = 'accept_example' # str | A version of the API that should be used for the request. For example, to use version \"2019.10\", set the value to \"application/vnd.dyspatch.2019.10+json\"
110+
accept = 'accept_example' # str | A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\"
111111

112112
try:
113113
# Get Draft by ID
@@ -123,7 +123,7 @@ Name | Type | Description | Notes
123123
------------- | ------------- | ------------- | -------------
124124
**draft_id** | **str**| A draft ID |
125125
**target_language** | **str**| The type of templating language to compile as. Should only be used for visual templates. |
126-
**accept** | **str**| A version of the API that should be used for the request. For example, to use version \"2019.10\", set the value to \"application/vnd.dyspatch.2019.10+json\" |
126+
**accept** | **str**| A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\" |
127127

128128
### Return type
129129

@@ -136,7 +136,7 @@ Name | Type | Description | Notes
136136
### HTTP request headers
137137

138138
- **Content-Type**: Not defined
139-
- **Accept**: application/vnd.dyspatch.2019.10+json, */*
139+
- **Accept**: application/vnd.dyspatch.2020.04+json, */*
140140

141141
### HTTP response details
142142
| Status code | Description | Response headers |
@@ -157,7 +157,7 @@ Name | Type | Description | Notes
157157
158158
Get localization keys
159159

160-
Returns the list of values that need to be translated for the draft. Set the `Accept` header to `application/vnd.dyspatch.2019.10+json` to get a JSON object, or `text/vnd.dyspatch.2019.10+x-gettext-translation` to get the POT file.
160+
Returns the list of values that need to be translated for the draft. Set the `Accept` header to `application/vnd.dyspatch.2020.04+json` to get a JSON object, or `text/vnd.dyspatch.2020.04+x-gettext-translation` to get the POT file.
161161

162162
### Example
163163

@@ -179,7 +179,7 @@ configuration.host = "https://api.dyspatch.io"
179179
# Create an instance of the API class
180180
api_instance = dyspatch_client.DraftsApi(dyspatch_client.ApiClient(configuration))
181181
draft_id = 'draft_id_example' # str | A draft ID
182-
accept = 'accept_example' # str | A version of the API that should be used for the request. For example, to use version \"2019.10\", set the value to \"application/vnd.dyspatch.2019.10+json\"
182+
accept = 'accept_example' # str | A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\"
183183

184184
try:
185185
# Get localization keys
@@ -194,7 +194,7 @@ except ApiException as e:
194194
Name | Type | Description | Notes
195195
------------- | ------------- | ------------- | -------------
196196
**draft_id** | **str**| A draft ID |
197-
**accept** | **str**| A version of the API that should be used for the request. For example, to use version \"2019.10\", set the value to \"application/vnd.dyspatch.2019.10+json\" |
197+
**accept** | **str**| A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\" |
198198

199199
### Return type
200200

@@ -207,7 +207,7 @@ Name | Type | Description | Notes
207207
### HTTP request headers
208208

209209
- **Content-Type**: Not defined
210-
- **Accept**: application/vnd.dyspatch.2019.10+json, text/vnd.dyspatch.2019.10+x-gettext-translation
210+
- **Accept**: application/vnd.dyspatch.2020.04+json, text/vnd.dyspatch.2020.04+x-gettext-translation
211211

212212
### HTTP response details
213213
| Status code | Description | Response headers |
@@ -242,7 +242,7 @@ configuration.api_key['Authorization'] = 'YOUR_API_KEY'
242242
configuration.host = "https://api.dyspatch.io"
243243
# Create an instance of the API class
244244
api_instance = dyspatch_client.DraftsApi(dyspatch_client.ApiClient(configuration))
245-
accept = 'accept_example' # str | A version of the API that should be used for the request. For example, to use version \"2019.10\", set the value to \"application/vnd.dyspatch.2019.10+json\"
245+
accept = 'accept_example' # str | A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\"
246246
cursor = 'cursor_example' # str | A cursor value used to retrieve a specific page from a paginated result set. (optional)
247247
status = 'status_example' # str | Filter the list of drafts by a particular status (optional)
248248

@@ -258,7 +258,7 @@ except ApiException as e:
258258

259259
Name | Type | Description | Notes
260260
------------- | ------------- | ------------- | -------------
261-
**accept** | **str**| A version of the API that should be used for the request. For example, to use version \"2019.10\", set the value to \"application/vnd.dyspatch.2019.10+json\" |
261+
**accept** | **str**| A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\" |
262262
**cursor** | **str**| A cursor value used to retrieve a specific page from a paginated result set. | [optional]
263263
**status** | **str**| Filter the list of drafts by a particular status | [optional]
264264

@@ -273,7 +273,7 @@ Name | Type | Description | Notes
273273
### HTTP request headers
274274

275275
- **Content-Type**: Not defined
276-
- **Accept**: application/vnd.dyspatch.2019.10+json, */*
276+
- **Accept**: application/vnd.dyspatch.2020.04+json, */*
277277

278278
### HTTP response details
279279
| Status code | Description | Response headers |
@@ -316,7 +316,7 @@ configuration.host = "https://api.dyspatch.io"
316316
# Create an instance of the API class
317317
api_instance = dyspatch_client.DraftsApi(dyspatch_client.ApiClient(configuration))
318318
draft_id = 'draft_id_example' # str | A draft ID
319-
accept = 'accept_example' # str | A version of the API that should be used for the request. For example, to use version \"2019.10\", set the value to \"application/vnd.dyspatch.2019.10+json\"
319+
accept = 'accept_example' # str | A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\"
320320

321321
try:
322322
# Get localizations on a draft
@@ -331,7 +331,7 @@ except ApiException as e:
331331
Name | Type | Description | Notes
332332
------------- | ------------- | ------------- | -------------
333333
**draft_id** | **str**| A draft ID |
334-
**accept** | **str**| A version of the API that should be used for the request. For example, to use version \"2019.10\", set the value to \"application/vnd.dyspatch.2019.10+json\" |
334+
**accept** | **str**| A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\" |
335335

336336
### Return type
337337

@@ -344,7 +344,7 @@ Name | Type | Description | Notes
344344
### HTTP request headers
345345

346346
- **Content-Type**: Not defined
347-
- **Accept**: application/vnd.dyspatch.2019.10+json
347+
- **Accept**: application/vnd.dyspatch.2020.04+json
348348

349349
### HTTP response details
350350
| Status code | Description | Response headers |
@@ -381,7 +381,7 @@ configuration.host = "https://api.dyspatch.io"
381381
api_instance = dyspatch_client.DraftsApi(dyspatch_client.ApiClient(configuration))
382382
draft_id = 'draft_id_example' # str | A draft ID
383383
language_id = 'language_id_example' # str | A language ID (eg: en-US)
384-
accept = 'accept_example' # str | A version of the API that should be used for the request. For example, to use version \"2019.10\", set the value to \"application/vnd.dyspatch.2019.10+json\"
384+
accept = 'accept_example' # str | A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\"
385385
inline_object = dyspatch_client.InlineObject() # InlineObject |
386386

387387
try:
@@ -397,7 +397,7 @@ Name | Type | Description | Notes
397397
------------- | ------------- | ------------- | -------------
398398
**draft_id** | **str**| A draft ID |
399399
**language_id** | **str**| A language ID (eg: en-US) |
400-
**accept** | **str**| A version of the API that should be used for the request. For example, to use version \"2019.10\", set the value to \"application/vnd.dyspatch.2019.10+json\" |
400+
**accept** | **str**| A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\" |
401401
**inline_object** | [**InlineObject**](InlineObject.md)| |
402402

403403
### Return type
@@ -448,7 +448,7 @@ configuration.host = "https://api.dyspatch.io"
448448
api_instance = dyspatch_client.DraftsApi(dyspatch_client.ApiClient(configuration))
449449
draft_id = 'draft_id_example' # str | A draft ID
450450
language_id = 'language_id_example' # str | A language ID (eg: en-US)
451-
accept = 'accept_example' # str | A version of the API that should be used for the request. For example, to use version \"2019.10\", set the value to \"application/vnd.dyspatch.2019.10+json\"
451+
accept = 'accept_example' # str | A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\"
452452
request_body = {'key': 'request_body_example'} # dict(str, str) |
453453

454454
try:
@@ -464,7 +464,7 @@ Name | Type | Description | Notes
464464
------------- | ------------- | ------------- | -------------
465465
**draft_id** | **str**| A draft ID |
466466
**language_id** | **str**| A language ID (eg: en-US) |
467-
**accept** | **str**| A version of the API that should be used for the request. For example, to use version \"2019.10\", set the value to \"application/vnd.dyspatch.2019.10+json\" |
467+
**accept** | **str**| A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\" |
468468
**request_body** | [**dict(str, str)**](str.md)| |
469469

470470
### Return type
@@ -478,12 +478,13 @@ void (empty response body)
478478
### HTTP request headers
479479

480480
- **Content-Type**: application/json
481-
- **Accept**: Not defined
481+
- **Accept**: */*
482482

483483
### HTTP response details
484484
| Status code | Description | Response headers |
485485
|-------------|-------------|------------------|
486486
**200** | Successful | - |
487+
**403** | Unauthorized | * X-RateLimit-Remaining - The number of requests left for the time window. <br> |
487488

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

@@ -514,7 +515,7 @@ configuration.host = "https://api.dyspatch.io"
514515
# Create an instance of the API class
515516
api_instance = dyspatch_client.DraftsApi(dyspatch_client.ApiClient(configuration))
516517
draft_id = 'draft_id_example' # str | A draft ID
517-
accept = 'accept_example' # str | A version of the API that should be used for the request. For example, to use version \"2019.10\", set the value to \"application/vnd.dyspatch.2019.10+json\"
518+
accept = 'accept_example' # str | A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\"
518519

519520
try:
520521
# Submit the draft for approval
@@ -528,7 +529,7 @@ except ApiException as e:
528529
Name | Type | Description | Notes
529530
------------- | ------------- | ------------- | -------------
530531
**draft_id** | **str**| A draft ID |
531-
**accept** | **str**| A version of the API that should be used for the request. For example, to use version \&quot;2019.10\&quot;, set the value to \&quot;application/vnd.dyspatch.2019.10+json\&quot; |
532+
**accept** | **str**| A version of the API that should be used for the request. For example, to use version \&quot;2020.04\&quot;, set the value to \&quot;application/vnd.dyspatch.2020.04+json\&quot; |
532533

533534
### Return type
534535

docs/LocalizationMetaRead.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,11 @@ localization metadata
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**localization** | **str** | An opaque, unique identifier for a localization | [optional]
8-
**language** | **str** | A language identifier comprised of a language and a country identifier. See [supported languages](https://docs.dyspatch.io/localization/supported_languages/). | [optional]
7+
**id** | **str** | An opaque, unique identifier for a localization | [optional]
98
**name** | **str** | The user-specified name of a localization | [optional]
109
**url** | **str** | The API url for a specific localization | [optional]
10+
**locale_group** | **str** | the locale group this localization belongs to, if this field is empty the localization does not belong to any locale group | [optional]
11+
**languages** | **list[str]** | a list of locale codes that are available in the localization. See [supported languages](https://docs.dyspatch.io/localization/supported_languages/) for an exhaustive list of locale codes. | [optional]
1112

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

docs/LocalizationRead.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,14 @@ localization metadata and latest revision for associated template
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**id** | **str** | An opaque, unique identifier for a localization | [optional]
8-
**language** | **str** | A language identifier comprised of a language and a country identifier. See [supported languages](https://docs.dyspatch.io/localization/supported_languages/). | [optional]
8+
**languages** | **list[str]** | a list of locale codes that are available in the localization. See [supported languages](https://docs.dyspatch.io/localization/supported_languages/) for an exhaustive list of locale codes. | [optional]
99
**url** | **str** | The API url for a specific localization | [optional]
1010
**template** | **str** | An opaque, unique identifier for a template | [optional]
1111
**compiled** | [**CompiledRead**](CompiledRead.md) | | [optional]
1212
**created_at** | **datetime** | The time of initial creation | [optional]
1313
**updated_at** | **datetime** | The time of last update | [optional]
1414
**name** | **str** | The user-specified name of a localization | [optional]
15+
**locale_group** | **str** | the locale group this localization belongs to, if this field is empty the localization does not belong to any locale group | [optional]
1516

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

docs/LocalizationsApi.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ configuration.host = "https://api.dyspatch.io"
3535
api_instance = dyspatch_client.LocalizationsApi(dyspatch_client.ApiClient(configuration))
3636
localization_id = 'localization_id_example' # str | A localization ID
3737
target_language = 'target_language_example' # str | The type of templating language to compile as. Should only be used for visual templates.
38-
accept = 'accept_example' # str | A version of the API that should be used for the request. For example, to use version \"2019.10\", set the value to \"application/vnd.dyspatch.2019.10+json\"
38+
accept = 'accept_example' # str | A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\"
3939

4040
try:
4141
# Get Localization Object by ID
@@ -51,7 +51,7 @@ Name | Type | Description | Notes
5151
------------- | ------------- | ------------- | -------------
5252
**localization_id** | **str**| A localization ID |
5353
**target_language** | **str**| The type of templating language to compile as. Should only be used for visual templates. |
54-
**accept** | **str**| A version of the API that should be used for the request. For example, to use version \&quot;2019.10\&quot;, set the value to \&quot;application/vnd.dyspatch.2019.10+json\&quot; |
54+
**accept** | **str**| A version of the API that should be used for the request. For example, to use version \&quot;2020.04\&quot;, set the value to \&quot;application/vnd.dyspatch.2020.04+json\&quot; |
5555

5656
### Return type
5757

@@ -64,7 +64,7 @@ Name | Type | Description | Notes
6464
### HTTP request headers
6565

6666
- **Content-Type**: Not defined
67-
- **Accept**: application/vnd.dyspatch.2019.10+json, */*
67+
- **Accept**: application/vnd.dyspatch.2020.04+json, */*
6868

6969
### HTTP response details
7070
| Status code | Description | Response headers |

0 commit comments

Comments
 (0)