dyspatch_client 5.0.1 → 6.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (52) hide show
  1. checksums.yaml +5 -5
  2. data/README.md +9 -7
  3. data/docs/CompiledRead.md +4 -2
  4. data/docs/DraftsApi.md +21 -21
  5. data/docs/LocalizationsApi.md +70 -9
  6. data/docs/TemplatesApi.md +6 -6
  7. data/dyspatch_client.gemspec +1 -1
  8. data/lib/dyspatch_client.rb +1 -1
  9. data/lib/dyspatch_client/api/drafts_api.rb +26 -26
  10. data/lib/dyspatch_client/api/localizations_api.rb +102 -15
  11. data/lib/dyspatch_client/api/templates_api.rb +8 -8
  12. data/lib/dyspatch_client/api_client.rb +1 -1
  13. data/lib/dyspatch_client/api_error.rb +1 -1
  14. data/lib/dyspatch_client/configuration.rb +1 -1
  15. data/lib/dyspatch_client/models/api_error.rb +1 -1
  16. data/lib/dyspatch_client/models/compiled_read.rb +12 -2
  17. data/lib/dyspatch_client/models/cursor.rb +1 -1
  18. data/lib/dyspatch_client/models/draft_meta_read.rb +1 -1
  19. data/lib/dyspatch_client/models/draft_read.rb +1 -1
  20. data/lib/dyspatch_client/models/drafts_read.rb +1 -1
  21. data/lib/dyspatch_client/models/inline_object.rb +1 -1
  22. data/lib/dyspatch_client/models/localization_key_read.rb +1 -1
  23. data/lib/dyspatch_client/models/localization_meta_read.rb +1 -1
  24. data/lib/dyspatch_client/models/localization_read.rb +1 -1
  25. data/lib/dyspatch_client/models/template_meta_read.rb +1 -1
  26. data/lib/dyspatch_client/models/template_read.rb +1 -1
  27. data/lib/dyspatch_client/models/templates_read.rb +1 -1
  28. data/lib/dyspatch_client/version.rb +2 -2
  29. data/spec/api/drafts_api_spec.rb +10 -10
  30. data/spec/api/localizations_api_spec.rb +20 -5
  31. data/spec/api/templates_api_spec.rb +3 -3
  32. data/spec/api_client_spec.rb +1 -1
  33. data/spec/configuration_spec.rb +1 -1
  34. data/spec/spec_helper.rb +1 -1
  35. metadata +16 -46
  36. data/LICENSE +0 -202
  37. data/pkg/dyspatch_client-5.0.0.gem +0 -0
  38. data/pkg/dyspatch_client-5.0.1.gem +0 -0
  39. data/spec/integration_spec.rb +0 -41
  40. data/spec/models/api_error_spec.rb +0 -57
  41. data/spec/models/compiled_read_spec.rb +0 -65
  42. data/spec/models/cursor_spec.rb +0 -47
  43. data/spec/models/draft_meta_read_spec.rb +0 -77
  44. data/spec/models/draft_read_spec.rb +0 -83
  45. data/spec/models/drafts_read_spec.rb +0 -47
  46. data/spec/models/inline_object_spec.rb +0 -41
  47. data/spec/models/localization_key_read_spec.rb +0 -47
  48. data/spec/models/localization_meta_read_spec.rb +0 -65
  49. data/spec/models/localization_read_spec.rb +0 -89
  50. data/spec/models/template_meta_read_spec.rb +0 -77
  51. data/spec/models/template_read_spec.rb +0 -83
  52. data/spec/models/templates_read_spec.rb +0 -47
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA256:
3
- metadata.gz: efc7d9ea4c7fcb547486a77d1f04877f8fbdd412501b3a7bea81fbc6a0d5b3c4
4
- data.tar.gz: b7f721a5488733bd98ac18609e6d8f776d78b1278008f04536fbf65bb29c4f11
2
+ SHA1:
3
+ metadata.gz: 1bca48e6247df466eb49fab54a5f2ff7a2aba594
4
+ data.tar.gz: 1cc120d620ec9d5543327019a73aa71b58b7a1f0
5
5
  SHA512:
6
- metadata.gz: 4bb84b56ba3e0250ff3a23401feba616e5d055e1dee3f581f6cf2fdfe771fb792739cafb1e3c5300b4b9b792d67a0e3a631b552b8b511249141566b840b9afa5
7
- data.tar.gz: '08494dc1e12148ddf48ff7e30f090514c69da14665cebea973be5e788272661a53d96f0a29fb92398f5ca167a4924f5108767a781df5cef4c5856b4a2d06d9ad'
6
+ metadata.gz: e8192f911b43b0149a1c90f97fa7b1911c96dedab1ac6dd364eba8f8c039779248fb03303e8bdc7bf77c995f0ee7919d53714f2b139f8872dfcd8a2e96ce20ec
7
+ data.tar.gz: fb5be5156122be9a99582b47b832fc75897bdb04faf2905d2548348fbb01fd65ae0196960c4da0cb0c4321d6f109687bc160d48e58254d6cc420d5f01e686e5e
data/README.md CHANGED
@@ -22,8 +22,8 @@ Dyspatch provides API Clients for popular languages and web frameworks.
22
22
 
23
23
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
24
24
 
25
- - API version: 2020.04
26
- - Package version: 5.0.1
25
+ - API version: 2020.11
26
+ - Package version: 6.0.0
27
27
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
28
28
  For more information, please visit [https://docs.dyspatch.io](https://docs.dyspatch.io)
29
29
 
@@ -40,16 +40,16 @@ gem build dyspatch_client.gemspec
40
40
  Then either install the gem locally:
41
41
 
42
42
  ```shell
43
- gem install ./dyspatch_client-5.0.1.gem
43
+ gem install ./dyspatch_client-6.0.0.gem
44
44
  ```
45
45
 
46
- (for development, run `gem install --dev ./dyspatch_client-5.0.1.gem` to install the development dependencies)
46
+ (for development, run `gem install --dev ./dyspatch_client-6.0.0.gem` to install the development dependencies)
47
47
 
48
48
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
49
49
 
50
50
  Finally add this to the Gemfile:
51
51
 
52
- gem 'dyspatch_client', '~> 5.0.1'
52
+ gem 'dyspatch_client', '~> 6.0.0'
53
53
 
54
54
  ### Install from Git
55
55
 
@@ -84,7 +84,7 @@ end
84
84
  api_instance = DyspatchClient::DraftsApi.new
85
85
  draft_id = 'draft_id_example' # String | A draft ID
86
86
  language_id = 'language_id_example' # String | A language ID (eg: en-US)
87
- accept = 'accept_example' # String | 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\"
87
+ accept = 'accept_example' # String | A version of the API that should be used for the request. For example, to use version \"2020.11\", set the value to \"application/vnd.dyspatch.2020.11+json\"
88
88
 
89
89
  begin
90
90
  #Remove a localization
@@ -109,7 +109,8 @@ Class | Method | HTTP request | Description
109
109
  *DyspatchClient::DraftsApi* | [**save_localization**](docs/DraftsApi.md#save_localization) | **PUT** /drafts/{draftId}/localizations/{languageId} | Create or update a localization
110
110
  *DyspatchClient::DraftsApi* | [**set_translation**](docs/DraftsApi.md#set_translation) | **PUT** /drafts/{draftId}/localizations/{languageId}/translations | Set translations for language
111
111
  *DyspatchClient::DraftsApi* | [**submit_draft_for_approval**](docs/DraftsApi.md#submit_draft_for_approval) | **POST** /drafts/{draftId}/publishRequest | Submit the draft for approval
112
- *DyspatchClient::LocalizationsApi* | [**get_localization_by_id**](docs/LocalizationsApi.md#get_localization_by_id) | **GET** /localizations/{localizationId} | Get Localization Object by ID
112
+ *DyspatchClient::LocalizationsApi* | [**get_draft_localization_by_id**](docs/LocalizationsApi.md#get_draft_localization_by_id) | **GET** /localizations/{localizationId}/drafts/{draftId} | Get Draft Localization Object by ID
113
+ *DyspatchClient::LocalizationsApi* | [**get_published_localization_by_id**](docs/LocalizationsApi.md#get_published_localization_by_id) | **GET** /localizations/{localizationId} | Get Localization Object by ID
113
114
  *DyspatchClient::TemplatesApi* | [**get_template_by_id**](docs/TemplatesApi.md#get_template_by_id) | **GET** /templates/{templateId} | Get Template by ID
114
115
  *DyspatchClient::TemplatesApi* | [**get_templates**](docs/TemplatesApi.md#get_templates) | **GET** /templates | List Templates
115
116
 
@@ -140,3 +141,4 @@ Class | Method | HTTP request | Description
140
141
  - **Type**: API key
141
142
  - **API key parameter name**: Authorization
142
143
  - **Location**: HTTP header
144
+
data/docs/CompiledRead.md CHANGED
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
8
8
  **reply_to** | **String** | Reply-To address | [optional]
9
9
  **subject** | **String** | Base64 encoded template subject line | [optional]
10
10
  **html** | **String** | Base64 encoded template HTML body | [optional]
11
+ **amp_html** | **String** | Base64 encoded template AMP body | [optional]
11
12
  **text** | **String** | Base64 encoded template text body | [optional]
12
13
 
13
14
  ## Code Sample
@@ -15,10 +16,11 @@ Name | Type | Description | Notes
15
16
  ```ruby
16
17
  require 'DyspatchClient'
17
18
 
18
- instance = DyspatchClient::CompiledRead.new(sender: Example,
19
- reply_to: Example,
19
+ instance = DyspatchClient::CompiledRead.new(sender: example@example.com,
20
+ reply_to: example@example.com,
20
21
  subject: null,
21
22
  html: null,
23
+ amp_html: null,
22
24
  text: null)
23
25
  ```
24
26
 
data/docs/DraftsApi.md CHANGED
@@ -39,7 +39,7 @@ end
39
39
  api_instance = DyspatchClient::DraftsApi.new
40
40
  draft_id = 'draft_id_example' # String | A draft ID
41
41
  language_id = 'language_id_example' # String | A language ID (eg: en-US)
42
- accept = 'accept_example' # String | 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\"
42
+ accept = 'accept_example' # String | A version of the API that should be used for the request. For example, to use version \"2020.11\", set the value to \"application/vnd.dyspatch.2020.11+json\"
43
43
 
44
44
  begin
45
45
  #Remove a localization
@@ -56,7 +56,7 @@ Name | Type | Description | Notes
56
56
  ------------- | ------------- | ------------- | -------------
57
57
  **draft_id** | **String**| A draft ID |
58
58
  **language_id** | **String**| A language ID (eg: en-US) |
59
- **accept** | **String**| 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\" |
59
+ **accept** | **String**| A version of the API that should be used for the request. For example, to use version \"2020.11\", set the value to \"application/vnd.dyspatch.2020.11+json\" |
60
60
 
61
61
  ### Return type
62
62
 
@@ -96,7 +96,7 @@ end
96
96
  api_instance = DyspatchClient::DraftsApi.new
97
97
  draft_id = 'draft_id_example' # String | A draft ID
98
98
  target_language = 'target_language_example' # String | The type of templating language to compile as. Should only be used for visual templates.
99
- accept = 'accept_example' # String | 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\"
99
+ accept = 'accept_example' # String | A version of the API that should be used for the request. For example, to use version \"2020.11\", set the value to \"application/vnd.dyspatch.2020.11+json\"
100
100
 
101
101
  begin
102
102
  #Get Draft by ID
@@ -114,7 +114,7 @@ Name | Type | Description | Notes
114
114
  ------------- | ------------- | ------------- | -------------
115
115
  **draft_id** | **String**| A draft ID |
116
116
  **target_language** | **String**| The type of templating language to compile as. Should only be used for visual templates. |
117
- **accept** | **String**| 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\" |
117
+ **accept** | **String**| A version of the API that should be used for the request. For example, to use version \"2020.11\", set the value to \"application/vnd.dyspatch.2020.11+json\" |
118
118
 
119
119
  ### Return type
120
120
 
@@ -127,7 +127,7 @@ Name | Type | Description | Notes
127
127
  ### HTTP request headers
128
128
 
129
129
  - **Content-Type**: Not defined
130
- - **Accept**: application/vnd.dyspatch.2020.04+json, */*
130
+ - **Accept**: application/vnd.dyspatch.2020.11+json, */*
131
131
 
132
132
 
133
133
  ## get_draft_localization_keys
@@ -136,7 +136,7 @@ Name | Type | Description | Notes
136
136
 
137
137
  Get localization keys
138
138
 
139
- 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.
139
+ Returns the list of values that need to be translated for the draft. Set the `Accept` header to `application/vnd.dyspatch.2020.11+json` to get a JSON object, or `text/vnd.dyspatch.2020.11+x-gettext-translation` to get the POT file.
140
140
 
141
141
  ### Example
142
142
 
@@ -153,7 +153,7 @@ end
153
153
 
154
154
  api_instance = DyspatchClient::DraftsApi.new
155
155
  draft_id = 'draft_id_example' # String | A draft ID
156
- accept = 'accept_example' # String | 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\"
156
+ accept = 'accept_example' # String | A version of the API that should be used for the request. For example, to use version \"2020.11\", set the value to \"application/vnd.dyspatch.2020.11+json\"
157
157
 
158
158
  begin
159
159
  #Get localization keys
@@ -170,7 +170,7 @@ end
170
170
  Name | Type | Description | Notes
171
171
  ------------- | ------------- | ------------- | -------------
172
172
  **draft_id** | **String**| A draft ID |
173
- **accept** | **String**| 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\" |
173
+ **accept** | **String**| A version of the API that should be used for the request. For example, to use version \"2020.11\", set the value to \"application/vnd.dyspatch.2020.11+json\" |
174
174
 
175
175
  ### Return type
176
176
 
@@ -183,7 +183,7 @@ Name | Type | Description | Notes
183
183
  ### HTTP request headers
184
184
 
185
185
  - **Content-Type**: Not defined
186
- - **Accept**: application/vnd.dyspatch.2020.04+json, text/vnd.dyspatch.2020.04+x-gettext-translation
186
+ - **Accept**: application/vnd.dyspatch.2020.11+json, text/vnd.dyspatch.2020.11+x-gettext-translation
187
187
 
188
188
 
189
189
  ## get_drafts
@@ -208,7 +208,7 @@ DyspatchClient.configure do |config|
208
208
  end
209
209
 
210
210
  api_instance = DyspatchClient::DraftsApi.new
211
- accept = 'accept_example' # String | 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\"
211
+ accept = 'accept_example' # String | A version of the API that should be used for the request. For example, to use version \"2020.11\", set the value to \"application/vnd.dyspatch.2020.11+json\"
212
212
  opts = {
213
213
  cursor: 'cursor_example', # String | A cursor value used to retrieve a specific page from a paginated result set.
214
214
  status: 'status_example' # String | Filter the list of drafts by a particular status
@@ -228,7 +228,7 @@ end
228
228
 
229
229
  Name | Type | Description | Notes
230
230
  ------------- | ------------- | ------------- | -------------
231
- **accept** | **String**| 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\" |
231
+ **accept** | **String**| A version of the API that should be used for the request. For example, to use version \"2020.11\", set the value to \"application/vnd.dyspatch.2020.11+json\" |
232
232
  **cursor** | **String**| A cursor value used to retrieve a specific page from a paginated result set. | [optional]
233
233
  **status** | **String**| Filter the list of drafts by a particular status | [optional]
234
234
 
@@ -243,7 +243,7 @@ Name | Type | Description | Notes
243
243
  ### HTTP request headers
244
244
 
245
245
  - **Content-Type**: Not defined
246
- - **Accept**: application/vnd.dyspatch.2020.04+json, */*
246
+ - **Accept**: application/vnd.dyspatch.2020.11+json, */*
247
247
 
248
248
 
249
249
  ## get_localization_for_draft
@@ -269,7 +269,7 @@ end
269
269
 
270
270
  api_instance = DyspatchClient::DraftsApi.new
271
271
  draft_id = 'draft_id_example' # String | A draft ID
272
- accept = 'accept_example' # String | 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\"
272
+ accept = 'accept_example' # String | A version of the API that should be used for the request. For example, to use version \"2020.11\", set the value to \"application/vnd.dyspatch.2020.11+json\"
273
273
 
274
274
  begin
275
275
  #Get localizations on a draft
@@ -286,7 +286,7 @@ end
286
286
  Name | Type | Description | Notes
287
287
  ------------- | ------------- | ------------- | -------------
288
288
  **draft_id** | **String**| A draft ID |
289
- **accept** | **String**| 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\" |
289
+ **accept** | **String**| A version of the API that should be used for the request. For example, to use version \"2020.11\", set the value to \"application/vnd.dyspatch.2020.11+json\" |
290
290
 
291
291
  ### Return type
292
292
 
@@ -299,7 +299,7 @@ Name | Type | Description | Notes
299
299
  ### HTTP request headers
300
300
 
301
301
  - **Content-Type**: Not defined
302
- - **Accept**: application/vnd.dyspatch.2020.04+json
302
+ - **Accept**: application/vnd.dyspatch.2020.11+json
303
303
 
304
304
 
305
305
  ## save_localization
@@ -326,7 +326,7 @@ end
326
326
  api_instance = DyspatchClient::DraftsApi.new
327
327
  draft_id = 'draft_id_example' # String | A draft ID
328
328
  language_id = 'language_id_example' # String | A language ID (eg: en-US)
329
- accept = 'accept_example' # String | 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\"
329
+ accept = 'accept_example' # String | A version of the API that should be used for the request. For example, to use version \"2020.11\", set the value to \"application/vnd.dyspatch.2020.11+json\"
330
330
  inline_object = DyspatchClient::InlineObject.new # InlineObject |
331
331
 
332
332
  begin
@@ -344,7 +344,7 @@ Name | Type | Description | Notes
344
344
  ------------- | ------------- | ------------- | -------------
345
345
  **draft_id** | **String**| A draft ID |
346
346
  **language_id** | **String**| A language ID (eg: en-US) |
347
- **accept** | **String**| 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\" |
347
+ **accept** | **String**| A version of the API that should be used for the request. For example, to use version \"2020.11\", set the value to \"application/vnd.dyspatch.2020.11+json\" |
348
348
  **inline_object** | [**InlineObject**](InlineObject.md)| |
349
349
 
350
350
  ### Return type
@@ -385,7 +385,7 @@ end
385
385
  api_instance = DyspatchClient::DraftsApi.new
386
386
  draft_id = 'draft_id_example' # String | A draft ID
387
387
  language_id = 'language_id_example' # String | A language ID (eg: en-US)
388
- accept = 'accept_example' # String | 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\"
388
+ accept = 'accept_example' # String | A version of the API that should be used for the request. For example, to use version \"2020.11\", set the value to \"application/vnd.dyspatch.2020.11+json\"
389
389
  request_body = {'key' => 'request_body_example'} # Hash<String, String> |
390
390
 
391
391
  begin
@@ -403,7 +403,7 @@ Name | Type | Description | Notes
403
403
  ------------- | ------------- | ------------- | -------------
404
404
  **draft_id** | **String**| A draft ID |
405
405
  **language_id** | **String**| A language ID (eg: en-US) |
406
- **accept** | **String**| 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; |
406
+ **accept** | **String**| A version of the API that should be used for the request. For example, to use version \&quot;2020.11\&quot;, set the value to \&quot;application/vnd.dyspatch.2020.11+json\&quot; |
407
407
  **request_body** | [**Hash&lt;String, String&gt;**](String.md)| |
408
408
 
409
409
  ### Return type
@@ -443,7 +443,7 @@ end
443
443
 
444
444
  api_instance = DyspatchClient::DraftsApi.new
445
445
  draft_id = 'draft_id_example' # String | A draft ID
446
- accept = 'accept_example' # String | 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\"
446
+ accept = 'accept_example' # String | A version of the API that should be used for the request. For example, to use version \"2020.11\", set the value to \"application/vnd.dyspatch.2020.11+json\"
447
447
 
448
448
  begin
449
449
  #Submit the draft for approval
@@ -459,7 +459,7 @@ end
459
459
  Name | Type | Description | Notes
460
460
  ------------- | ------------- | ------------- | -------------
461
461
  **draft_id** | **String**| A draft ID |
462
- **accept** | **String**| 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; |
462
+ **accept** | **String**| A version of the API that should be used for the request. For example, to use version \&quot;2020.11\&quot;, set the value to \&quot;application/vnd.dyspatch.2020.11+json\&quot; |
463
463
 
464
464
  ### Return type
465
465
 
data/docs/LocalizationsApi.md CHANGED
@@ -4,17 +4,78 @@ All URIs are relative to *https://api.dyspatch.io*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
- [**get_localization_by_id**](LocalizationsApi.md#get_localization_by_id) | **GET** /localizations/{localizationId} | Get Localization Object by ID
7
+ [**get_draft_localization_by_id**](LocalizationsApi.md#get_draft_localization_by_id) | **GET** /localizations/{localizationId}/drafts/{draftId} | Get Draft Localization Object by ID
8
+ [**get_published_localization_by_id**](LocalizationsApi.md#get_published_localization_by_id) | **GET** /localizations/{localizationId} | Get Localization Object by ID
8
9
 
9
10
 
10
11
 
11
- ## get_localization_by_id
12
+ ## get_draft_localization_by_id
12
13
 
13
- > LocalizationRead get_localization_by_id(localization_id, target_language, accept)
14
+ > LocalizationRead get_draft_localization_by_id(draft_id, localization_id, target_language, accept)
15
+
16
+ Get Draft Localization Object by ID
17
+
18
+ Returns a specific localization object of the matching draft with a matching localization ID
19
+
20
+ ### Example
21
+
22
+ ```ruby
23
+ # load the gem
24
+ require 'dyspatch_client'
25
+ # setup authorization
26
+ DyspatchClient.configure do |config|
27
+ # Configure API key authorization: Bearer
28
+ config.api_key['Authorization'] = 'YOUR API KEY'
29
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
30
+ #config.api_key_prefix['Authorization'] = 'Bearer'
31
+ end
32
+
33
+ api_instance = DyspatchClient::LocalizationsApi.new
34
+ draft_id = 'draft_id_example' # String | A draft ID
35
+ localization_id = 'localization_id_example' # String | A localization ID
36
+ target_language = 'target_language_example' # String | The type of templating language to compile as. Should only be used for visual templates.
37
+ accept = 'accept_example' # String | A version of the API that should be used for the request. For example, to use version \"2020.11\", set the value to \"application/vnd.dyspatch.2020.11+json\"
38
+
39
+ begin
40
+ #Get Draft Localization Object by ID
41
+ result = api_instance.get_draft_localization_by_id(draft_id, localization_id, target_language, accept)
42
+ p result
43
+ rescue DyspatchClient::ApiError => e
44
+ puts "Exception when calling LocalizationsApi->get_draft_localization_by_id: #{e}"
45
+ end
46
+ ```
47
+
48
+ ### Parameters
49
+
50
+
51
+ Name | Type | Description | Notes
52
+ ------------- | ------------- | ------------- | -------------
53
+ **draft_id** | **String**| A draft ID |
54
+ **localization_id** | **String**| A localization ID |
55
+ **target_language** | **String**| The type of templating language to compile as. Should only be used for visual templates. |
56
+ **accept** | **String**| A version of the API that should be used for the request. For example, to use version \&quot;2020.11\&quot;, set the value to \&quot;application/vnd.dyspatch.2020.11+json\&quot; |
57
+
58
+ ### Return type
59
+
60
+ [**LocalizationRead**](LocalizationRead.md)
61
+
62
+ ### Authorization
63
+
64
+ [Bearer](../README.md#Bearer)
65
+
66
+ ### HTTP request headers
67
+
68
+ - **Content-Type**: Not defined
69
+ - **Accept**: application/vnd.dyspatch.2020.11+json, */*
70
+
71
+
72
+ ## get_published_localization_by_id
73
+
74
+ > LocalizationRead get_published_localization_by_id(localization_id, target_language, accept)
14
75
 
15
76
  Get Localization Object by ID
16
77
 
17
- Returns a specific localization object with a matching ID
78
+ Returns the published content associated with the localization of the matching ID
18
79
 
19
80
  ### Example
20
81
 
@@ -32,14 +93,14 @@ end
32
93
  api_instance = DyspatchClient::LocalizationsApi.new
33
94
  localization_id = 'localization_id_example' # String | A localization ID
34
95
  target_language = 'target_language_example' # String | The type of templating language to compile as. Should only be used for visual templates.
35
- accept = 'accept_example' # String | 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\"
96
+ accept = 'accept_example' # String | A version of the API that should be used for the request. For example, to use version \"2020.11\", set the value to \"application/vnd.dyspatch.2020.11+json\"
36
97
 
37
98
  begin
38
99
  #Get Localization Object by ID
39
- result = api_instance.get_localization_by_id(localization_id, target_language, accept)
100
+ result = api_instance.get_published_localization_by_id(localization_id, target_language, accept)
40
101
  p result
41
102
  rescue DyspatchClient::ApiError => e
42
- puts "Exception when calling LocalizationsApi->get_localization_by_id: #{e}"
103
+ puts "Exception when calling LocalizationsApi->get_published_localization_by_id: #{e}"
43
104
  end
44
105
  ```
45
106
 
@@ -50,7 +111,7 @@ Name | Type | Description | Notes
50
111
  ------------- | ------------- | ------------- | -------------
51
112
  **localization_id** | **String**| A localization ID |
52
113
  **target_language** | **String**| The type of templating language to compile as. Should only be used for visual templates. |
53
- **accept** | **String**| 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; |
114
+ **accept** | **String**| A version of the API that should be used for the request. For example, to use version \&quot;2020.11\&quot;, set the value to \&quot;application/vnd.dyspatch.2020.11+json\&quot; |
54
115
 
55
116
  ### Return type
56
117
 
@@ -63,5 +124,5 @@ Name | Type | Description | Notes
63
124
  ### HTTP request headers
64
125
 
65
126
  - **Content-Type**: Not defined
66
- - **Accept**: application/vnd.dyspatch.2020.04+json, */*
127
+ - **Accept**: application/vnd.dyspatch.2020.11+json, */*
67
128
 
data/docs/TemplatesApi.md CHANGED
@@ -33,7 +33,7 @@ end
33
33
  api_instance = DyspatchClient::TemplatesApi.new
34
34
  template_id = 'template_id_example' # String | A template ID
35
35
  target_language = 'target_language_example' # String | The type of templating language to compile as. Should only be used for visual templates.
36
- accept = 'accept_example' # String | 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\"
36
+ accept = 'accept_example' # String | A version of the API that should be used for the request. For example, to use version \"2020.11\", set the value to \"application/vnd.dyspatch.2020.11+json\"
37
37
 
38
38
  begin
39
39
  #Get Template by ID
@@ -51,7 +51,7 @@ Name | Type | Description | Notes
51
51
  ------------- | ------------- | ------------- | -------------
52
52
  **template_id** | **String**| A template ID |
53
53
  **target_language** | **String**| The type of templating language to compile as. Should only be used for visual templates. |
54
- **accept** | **String**| 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; |
54
+ **accept** | **String**| A version of the API that should be used for the request. For example, to use version \&quot;2020.11\&quot;, set the value to \&quot;application/vnd.dyspatch.2020.11+json\&quot; |
55
55
 
56
56
  ### Return type
57
57
 
@@ -64,7 +64,7 @@ Name | Type | Description | Notes
64
64
  ### HTTP request headers
65
65
 
66
66
  - **Content-Type**: Not defined
67
- - **Accept**: application/vnd.dyspatch.2020.04+json, */*
67
+ - **Accept**: application/vnd.dyspatch.2020.11+json, */*
68
68
 
69
69
 
70
70
  ## get_templates
@@ -89,7 +89,7 @@ DyspatchClient.configure do |config|
89
89
  end
90
90
 
91
91
  api_instance = DyspatchClient::TemplatesApi.new
92
- accept = 'accept_example' # String | 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\"
92
+ accept = 'accept_example' # String | A version of the API that should be used for the request. For example, to use version \"2020.11\", set the value to \"application/vnd.dyspatch.2020.11+json\"
93
93
  opts = {
94
94
  cursor: 'cursor_example' # String | A cursor value used to retrieve a specific page from a paginated result set.
95
95
  }
@@ -108,7 +108,7 @@ end
108
108
 
109
109
  Name | Type | Description | Notes
110
110
  ------------- | ------------- | ------------- | -------------
111
- **accept** | **String**| 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; |
111
+ **accept** | **String**| A version of the API that should be used for the request. For example, to use version \&quot;2020.11\&quot;, set the value to \&quot;application/vnd.dyspatch.2020.11+json\&quot; |
112
112
  **cursor** | **String**| A cursor value used to retrieve a specific page from a paginated result set. | [optional]
113
113
 
114
114
  ### Return type
@@ -122,5 +122,5 @@ Name | Type | Description | Notes
122
122
  ### HTTP request headers
123
123
 
124
124
  - **Content-Type**: Not defined
125
- - **Accept**: application/vnd.dyspatch.2020.04+json, */*
125
+ - **Accept**: application/vnd.dyspatch.2020.11+json, */*
126
126
 
data/dyspatch_client.gemspec CHANGED
@@ -5,7 +5,7 @@
5
5
 
6
6
  ## 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](https://docs.dyspatch.io/development/implementing_dyspatch/) for more details on how to implement Dyspatch. ## API Client Libraries Dyspatch provides API Clients for popular languages and web frameworks. - [Java](https://github.com/getdyspatch/dyspatch-java) - [Javascript](https://github.com/getdyspatch/dyspatch-javascript) - [Python](https://github.com/getdyspatch/dyspatch-python) - [C#](https://github.com/getdyspatch/dyspatch-dotnet) - [Go](https://github.com/getdyspatch/dyspatch-golang) - [Ruby](https://github.com/getdyspatch/dyspatch-ruby)
7
7
 
8
- The version of the OpenAPI document: 2020.04
8
+ The version of the OpenAPI document: 2020.11
9
9
  Contact: support@dyspatch.io
10
10
  Generated by: https://openapi-generator.tech
11
11
  OpenAPI Generator version: 4.3.1
data/lib/dyspatch_client.rb CHANGED
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## 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](https://docs.dyspatch.io/development/implementing_dyspatch/) for more details on how to implement Dyspatch. ## API Client Libraries Dyspatch provides API Clients for popular languages and web frameworks. - [Java](https://github.com/getdyspatch/dyspatch-java) - [Javascript](https://github.com/getdyspatch/dyspatch-javascript) - [Python](https://github.com/getdyspatch/dyspatch-python) - [C#](https://github.com/getdyspatch/dyspatch-dotnet) - [Go](https://github.com/getdyspatch/dyspatch-golang) - [Ruby](https://github.com/getdyspatch/dyspatch-ruby)
5
5
 
6
- The version of the OpenAPI document: 2020.04
6
+ The version of the OpenAPI document: 2020.11
7
7
  Contact: support@dyspatch.io
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 4.3.1