diff --git a/api/openapi.yaml b/api/openapi.yaml index 8750abf..9218363 100644 --- a/api/openapi.yaml +++ b/api/openapi.yaml @@ -23,7 +23,7 @@ info: - [Ruby](https://github.com/getdyspatch/dyspatch-ruby) termsOfService: https://www.dyspatch.io/legal/terms-of-service/ title: Dyspatch API - version: "2020.08" + version: "2020.11" x-logo: url: /api/dyspatch_logo.png servers: @@ -61,7 +61,7 @@ paths: type: string style: form - description: A version of the API that should be used for the request. For - example, to use version "2020.08", set the value to "application/vnd.dyspatch.2020.08+json" + example, to use version "2020.11", set the value to "application/vnd.dyspatch.2020.11+json" explode: false in: header name: Accept @@ -72,7 +72,7 @@ paths: responses: "200": content: - application/vnd.dyspatch.2020.08+json: + application/vnd.dyspatch.2020.11+json: schema: $ref: '#/components/schemas/TemplatesRead' description: A list of templates @@ -166,7 +166,7 @@ paths: summary: List Templates tags: - Templates - x-accepts: '*/*,application/vnd.dyspatch.2020.08+json' + x-accepts: '*/*,application/vnd.dyspatch.2020.11+json' /templates/{templateId}: get: description: Gets a template object with the matching ID. If the template has @@ -199,7 +199,7 @@ paths: type: string style: form - description: A version of the API that should be used for the request. For - example, to use version "2020.08", set the value to "application/vnd.dyspatch.2020.08+json" + example, to use version "2020.11", set the value to "application/vnd.dyspatch.2020.11+json" explode: false in: header name: Accept @@ -210,7 +210,7 @@ paths: responses: "200": content: - application/vnd.dyspatch.2020.08+json: + application/vnd.dyspatch.2020.11+json: schema: $ref: '#/components/schemas/TemplateRead' description: A template object with the requested ID. If the template has @@ -318,7 +318,7 @@ paths: summary: Get Template by ID tags: - Templates - x-accepts: '*/*,application/vnd.dyspatch.2020.08+json' + x-accepts: '*/*,application/vnd.dyspatch.2020.11+json' /drafts: get: description: Returns all drafts for your organization. @@ -344,7 +344,7 @@ paths: type: string style: form - description: A version of the API that should be used for the request. For - example, to use version "2020.08", set the value to "application/vnd.dyspatch.2020.08+json" + example, to use version "2020.11", set the value to "application/vnd.dyspatch.2020.11+json" explode: false in: header name: Accept @@ -355,7 +355,7 @@ paths: responses: "200": content: - application/vnd.dyspatch.2020.08+json: + application/vnd.dyspatch.2020.11+json: schema: $ref: '#/components/schemas/DraftsRead' description: Drafts @@ -462,7 +462,7 @@ paths: summary: List Drafts tags: - Drafts - x-accepts: '*/*,application/vnd.dyspatch.2020.08+json' + x-accepts: '*/*,application/vnd.dyspatch.2020.11+json' /drafts/{draftId}/publishRequest: post: description: Moves the draft into submitted state. @@ -477,7 +477,7 @@ paths: type: string style: simple - description: A version of the API that should be used for the request. For - example, to use version "2020.08", set the value to "application/vnd.dyspatch.2020.08+json" + example, to use version "2020.11", set the value to "application/vnd.dyspatch.2020.11+json" explode: false in: header name: Accept @@ -617,7 +617,7 @@ paths: type: string style: form - description: A version of the API that should be used for the request. For - example, to use version "2020.08", set the value to "application/vnd.dyspatch.2020.08+json" + example, to use version "2020.11", set the value to "application/vnd.dyspatch.2020.11+json" explode: false in: header name: Accept @@ -628,7 +628,7 @@ paths: responses: "200": content: - application/vnd.dyspatch.2020.08+json: + application/vnd.dyspatch.2020.11+json: schema: $ref: '#/components/schemas/DraftRead' description: A draft object with the requested ID. @@ -735,7 +735,7 @@ paths: summary: Get Draft by ID tags: - Drafts - x-accepts: '*/*,application/vnd.dyspatch.2020.08+json' + x-accepts: '*/*,application/vnd.dyspatch.2020.11+json' /drafts/{draftId}/localizations: get: description: Returns localization metadata for the draft @@ -750,7 +750,7 @@ paths: type: string style: simple - description: A version of the API that should be used for the request. For - example, to use version "2020.08", set the value to "application/vnd.dyspatch.2020.08+json" + example, to use version "2020.11", set the value to "application/vnd.dyspatch.2020.11+json" explode: false in: header name: Accept @@ -761,7 +761,7 @@ paths: responses: "200": content: - application/vnd.dyspatch.2020.08+json: + application/vnd.dyspatch.2020.11+json: schema: items: $ref: '#/components/schemas/LocalizationMetaRead' @@ -779,7 +779,7 @@ paths: summary: Get localizations on a draft tags: - Drafts - x-accepts: application/vnd.dyspatch.2020.08+json + x-accepts: application/vnd.dyspatch.2020.11+json /drafts/{draftId}/localizations/{languageId}: delete: description: Deletes the localization with the given language ID if it exists @@ -802,7 +802,7 @@ paths: type: string style: simple - description: A version of the API that should be used for the request. For - example, to use version "2020.08", set the value to "application/vnd.dyspatch.2020.08+json" + example, to use version "2020.11", set the value to "application/vnd.dyspatch.2020.11+json" explode: false in: header name: Accept @@ -841,7 +841,7 @@ paths: type: string style: simple - description: A version of the API that should be used for the request. For - example, to use version "2020.08", set the value to "application/vnd.dyspatch.2020.08+json" + example, to use version "2020.11", set the value to "application/vnd.dyspatch.2020.11+json" explode: false in: header name: Accept @@ -898,7 +898,7 @@ paths: type: string style: simple - description: A version of the API that should be used for the request. For - example, to use version "2020.08", set the value to "application/vnd.dyspatch.2020.08+json" + example, to use version "2020.11", set the value to "application/vnd.dyspatch.2020.11+json" explode: false in: header name: Accept @@ -943,8 +943,8 @@ paths: /drafts/{draftId}/localizationKeys: get: description: Returns the list of values that need to be translated for the draft. - Set the `Accept` header to `application/vnd.dyspatch.2020.08+json` to get - a JSON object, or `text/vnd.dyspatch.2020.08+x-gettext-translation` to get + 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. operationId: getDraftLocalizationKeys parameters: @@ -957,7 +957,7 @@ paths: type: string style: simple - description: A version of the API that should be used for the request. For - example, to use version "2020.08", set the value to "application/vnd.dyspatch.2020.08+json" + example, to use version "2020.11", set the value to "application/vnd.dyspatch.2020.11+json" explode: false in: header name: Accept @@ -968,12 +968,12 @@ paths: responses: "200": content: - application/vnd.dyspatch.2020.08+json: + application/vnd.dyspatch.2020.11+json: schema: items: $ref: '#/components/schemas/LocalizationKeyRead' type: array - text/vnd.dyspatch.2020.08+x-gettext-translation: + text/vnd.dyspatch.2020.11+x-gettext-translation: schema: format: binary type: string @@ -983,11 +983,12 @@ paths: summary: Get localization keys tags: - Drafts - x-accepts: application/vnd.dyspatch.2020.08+json,text/vnd.dyspatch.2020.08+x-gettext-translation + x-accepts: application/vnd.dyspatch.2020.11+json,text/vnd.dyspatch.2020.11+x-gettext-translation /localizations/{localizationId}: get: - description: Returns a specific localization object with a matching ID - operationId: getLocalizationById + description: Returns the published content associated with the localization + of the matching ID + operationId: getPublishedLocalizationById parameters: - description: A localization ID explode: false @@ -1015,7 +1016,7 @@ paths: type: string style: form - description: A version of the API that should be used for the request. For - example, to use version "2020.08", set the value to "application/vnd.dyspatch.2020.08+json" + example, to use version "2020.11", set the value to "application/vnd.dyspatch.2020.11+json" explode: false in: header name: Accept @@ -1026,7 +1027,7 @@ paths: responses: "200": content: - application/vnd.dyspatch.2020.08+json: + application/vnd.dyspatch.2020.11+json: schema: $ref: '#/components/schemas/LocalizationRead' description: A localization object with the requested ID @@ -1133,12 +1134,172 @@ paths: summary: Get Localization Object by ID tags: - Localizations - x-accepts: '*/*,application/vnd.dyspatch.2020.08+json' + x-accepts: '*/*,application/vnd.dyspatch.2020.11+json' + /localizations/{localizationId}/drafts/{draftId}: + get: + description: Returns a specific localization object of the matching draft with + a matching localization ID + operationId: getDraftLocalizationById + parameters: + - description: A draft ID + explode: false + in: path + name: draftId + required: true + schema: + type: string + style: simple + - description: A localization ID + explode: false + in: path + name: localizationId + required: true + schema: + type: string + style: simple + - description: The type of templating language to compile as. Should only be + used for visual templates. + explode: true + in: query + name: targetLanguage + required: true + schema: + enum: + - html + - handlebars + - ampscript + - freemarker + - cheetah + - jinja + - liquid + type: string + style: form + - description: 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" + explode: false + in: header + name: Accept + required: true + schema: + type: string + style: simple + responses: + "200": + content: + application/vnd.dyspatch.2020.11+json: + schema: + $ref: '#/components/schemas/LocalizationRead' + description: A localization object from the matching draft ID with the requested + ID + headers: + X-RateLimit-Remaining: + description: The number of requests left for the current time window + explode: false + schema: + type: integer + style: simple + "400": + content: + '*/*': + schema: + $ref: '#/components/schemas/APIError' + description: Invalid request + headers: + X-RateLimit-Remaining: + description: The number of requests left for the time window. + explode: false + schema: + type: integer + style: simple + "401": + content: + '*/*': + schema: + $ref: '#/components/schemas/APIError' + description: Unauthenticated + headers: + X-RateLimit-Remaining: + description: The number of requests left for the time window. + explode: false + schema: + type: integer + style: simple + "403": + content: + '*/*': + schema: + $ref: '#/components/schemas/APIError' + description: Unauthorized + headers: + X-RateLimit-Remaining: + description: The number of requests left for the time window. + explode: false + schema: + type: integer + style: simple + "404": + content: + '*/*': + schema: + $ref: '#/components/schemas/APIError' + description: Resource not found + headers: + X-RateLimit-Remaining: + description: The number of requests left for the time window. + explode: false + schema: + type: integer + style: simple + "429": + content: + '*/*': + schema: + $ref: '#/components/schemas/APIError' + description: Rate limit exceeded + headers: + X-RateLimit-Remaining: + description: The number of requests left for the time window. + explode: false + schema: + type: integer + style: simple + "500": + content: + '*/*': + schema: + $ref: '#/components/schemas/APIError' + description: Server error + headers: + X-RateLimit-Remaining: + description: The number of requests left for the time window. + explode: false + schema: + type: integer + style: simple + default: + content: + '*/*': + schema: + $ref: '#/components/schemas/APIError' + description: Server error + headers: + X-RateLimit-Remaining: + description: The number of requests left for the time window. + explode: false + schema: + type: integer + style: simple + security: + - Bearer: [] + summary: Get Draft Localization Object by ID + tags: + - Localizations + x-accepts: '*/*,application/vnd.dyspatch.2020.11+json' components: parameters: version: description: A version of the API that should be used for the request. For example, - to use version "2020.08", set the value to "application/vnd.dyspatch.2020.08+json" + to use version "2020.11", set the value to "application/vnd.dyspatch.2020.11+json" explode: false in: header name: Accept @@ -1493,10 +1654,10 @@ components: example: createdAt: 2000-01-23T04:56:07.000+00:00 compiled: - sender: Example + sender: example@example.com subject: subject ampHtml: ampHtml - replyTo: Example + replyTo: example@example.com html: html text: text localizations: @@ -1556,10 +1717,10 @@ components: template: tem_g3L7Cw6Hp5wU createdAt: 2000-01-23T04:56:07.000+00:00 compiled: - sender: Example + sender: example@example.com subject: subject ampHtml: ampHtml - replyTo: Example + replyTo: example@example.com html: html text: text localizations: @@ -1655,10 +1816,10 @@ components: createdAt: 2000-01-23T04:56:07.000+00:00 localeGroup: lgr_alka38ajla301 compiled: - sender: Example + sender: example@example.com subject: subject ampHtml: ampHtml - replyTo: Example + replyTo: example@example.com html: html text: text languages: @@ -1813,20 +1974,20 @@ components: CompiledRead: description: revision data example: - sender: Example + sender: example@example.com subject: subject ampHtml: ampHtml - replyTo: Example + replyTo: example@example.com html: html text: text properties: sender: description: Sender address - example: Example + example: example@example.com type: string replyTo: description: Reply-To address - example: Example + example: example@example.com type: string subject: description: Base64 encoded template subject line @@ -1837,7 +1998,7 @@ components: format: byte type: string ampHtml: - description: Base64 encoded amp version of template body + description: Base64 encoded template AMP body format: byte type: string text: @@ -1867,7 +2028,7 @@ components: curl --request GET \ --url https://api.dyspatch.io/templates \ --header 'Authorization: Bearer EXAMPLEAPIKEYXXXXXXXX12345678' \ - --header 'Accept: application/vnd.dyspatch.2020.08+json' + --header 'Accept: application/vnd.dyspatch.2020.11+json' ``` in: header name: Authorization diff --git a/docs/CompiledRead.md b/docs/CompiledRead.md index d5d1d8c..6384b63 100644 --- a/docs/CompiledRead.md +++ b/docs/CompiledRead.md @@ -11,7 +11,7 @@ Name | Type | Description | Notes **replyTo** | **String** | Reply-To address | [optional] **subject** | **byte[]** | Base64 encoded template subject line | [optional] **html** | **byte[]** | Base64 encoded template HTML body | [optional] -**ampHtml** | **byte[]** | Base64 encoded amp version of template body | [optional] +**ampHtml** | **byte[]** | Base64 encoded template AMP body | [optional] **text** | **byte[]** | Base64 encoded template text body | [optional] diff --git a/docs/DraftsApi.md b/docs/DraftsApi.md index e991fae..60b8c32 100644 --- a/docs/DraftsApi.md +++ b/docs/DraftsApi.md @@ -46,7 +46,7 @@ public class Example { DraftsApi apiInstance = new DraftsApi(defaultClient); String draftId = "draftId_example"; // String | A draft ID String languageId = "languageId_example"; // String | A language ID (eg: en-US) - String accept = "accept_example"; // String | A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" + String 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\" try { apiInstance.deleteLocalization(draftId, languageId, accept); } catch (ApiException e) { @@ -66,7 +66,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **draftId** | **String**| A draft ID | **languageId** | **String**| A language ID (eg: en-US) | - **accept** | **String**| A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" | + **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\" | ### Return type @@ -118,7 +118,7 @@ public class Example { DraftsApi apiInstance = new DraftsApi(defaultClient); String draftId = "draftId_example"; // String | A draft ID String targetLanguage = "targetLanguage_example"; // String | The type of templating language to compile as. Should only be used for visual templates. - String accept = "accept_example"; // String | A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" + String 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\" try { DraftRead result = apiInstance.getDraftById(draftId, targetLanguage, accept); System.out.println(result); @@ -139,7 +139,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **draftId** | **String**| A draft ID | **targetLanguage** | **String**| The type of templating language to compile as. Should only be used for visual templates. | [enum: html, handlebars, ampscript, freemarker, cheetah, jinja, liquid] - **accept** | **String**| A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" | + **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\" | ### Return type @@ -152,7 +152,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/vnd.dyspatch.2020.08+json, */* + - **Accept**: application/vnd.dyspatch.2020.11+json, */* ### HTTP response details | Status code | Description | Response headers | @@ -172,7 +172,7 @@ Name | Type | Description | Notes Get localization keys -Returns the list of values that need to be translated for the draft. Set the `Accept` header to `application/vnd.dyspatch.2020.08+json` to get a JSON object, or `text/vnd.dyspatch.2020.08+x-gettext-translation` to get the POT file. +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. ### Example ```java @@ -197,7 +197,7 @@ public class Example { DraftsApi apiInstance = new DraftsApi(defaultClient); String draftId = "draftId_example"; // String | A draft ID - String accept = "accept_example"; // String | A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" + String 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\" try { List result = apiInstance.getDraftLocalizationKeys(draftId, accept); System.out.println(result); @@ -217,7 +217,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **draftId** | **String**| A draft ID | - **accept** | **String**| A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" | + **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\" | ### Return type @@ -230,7 +230,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/vnd.dyspatch.2020.08+json, text/vnd.dyspatch.2020.08+x-gettext-translation + - **Accept**: application/vnd.dyspatch.2020.11+json, text/vnd.dyspatch.2020.11+x-gettext-translation ### HTTP response details | Status code | Description | Response headers | @@ -267,7 +267,7 @@ public class Example { //Bearer.setApiKeyPrefix("Token"); DraftsApi apiInstance = new DraftsApi(defaultClient); - String accept = "accept_example"; // String | A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" + String 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\" String cursor = "cursor_example"; // String | A cursor value used to retrieve a specific page from a paginated result set. String status = "status_example"; // String | Filter the list of drafts by a particular status try { @@ -288,7 +288,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **accept** | **String**| A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" | + **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\" | **cursor** | **String**| A cursor value used to retrieve a specific page from a paginated result set. | [optional] **status** | **String**| Filter the list of drafts by a particular status | [optional] [enum: awaitingTranslation] @@ -303,7 +303,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/vnd.dyspatch.2020.08+json, */* + - **Accept**: application/vnd.dyspatch.2020.11+json, */* ### HTTP response details | Status code | Description | Response headers | @@ -348,7 +348,7 @@ public class Example { DraftsApi apiInstance = new DraftsApi(defaultClient); String draftId = "draftId_example"; // String | A draft ID - String accept = "accept_example"; // String | A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" + String 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\" try { List result = apiInstance.getLocalizationForDraft(draftId, accept); System.out.println(result); @@ -368,7 +368,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **draftId** | **String**| A draft ID | - **accept** | **String**| A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" | + **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\" | ### Return type @@ -381,7 +381,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/vnd.dyspatch.2020.08+json + - **Accept**: application/vnd.dyspatch.2020.11+json ### HTTP response details | Status code | Description | Response headers | @@ -420,7 +420,7 @@ public class Example { DraftsApi apiInstance = new DraftsApi(defaultClient); String draftId = "draftId_example"; // String | A draft ID String languageId = "languageId_example"; // String | A language ID (eg: en-US) - String accept = "accept_example"; // String | A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" + String 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\" InlineObject inlineObject = new InlineObject(); // InlineObject | try { apiInstance.saveLocalization(draftId, languageId, accept, inlineObject); @@ -441,7 +441,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **draftId** | **String**| A draft ID | **languageId** | **String**| A language ID (eg: en-US) | - **accept** | **String**| A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" | + **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\" | **inlineObject** | [**InlineObject**](InlineObject.md)| | ### Return type @@ -494,7 +494,7 @@ public class Example { DraftsApi apiInstance = new DraftsApi(defaultClient); String draftId = "draftId_example"; // String | A draft ID String languageId = "languageId_example"; // String | A language ID (eg: en-US) - String accept = "accept_example"; // String | A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" + String 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\" Map requestBody = new HashMap(); // Map | try { apiInstance.setTranslation(draftId, languageId, accept, requestBody); @@ -515,7 +515,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **draftId** | **String**| A draft ID | **languageId** | **String**| A language ID (eg: en-US) | - **accept** | **String**| A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" | + **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\" | **requestBody** | [**Map<String, String>**](String.md)| | ### Return type @@ -568,7 +568,7 @@ public class Example { DraftsApi apiInstance = new DraftsApi(defaultClient); String draftId = "draftId_example"; // String | A draft ID - String accept = "accept_example"; // String | A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" + String 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\" try { apiInstance.submitDraftForApproval(draftId, accept); } catch (ApiException e) { @@ -587,7 +587,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **draftId** | **String**| A draft ID | - **accept** | **String**| A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" | + **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\" | ### Return type diff --git a/docs/LocalizationsApi.md b/docs/LocalizationsApi.md index 6314942..c8fc3ff 100644 --- a/docs/LocalizationsApi.md +++ b/docs/LocalizationsApi.md @@ -4,16 +4,99 @@ All URIs are relative to *https://api.dyspatch.io* Method | HTTP request | Description ------------- | ------------- | ------------- -[**getLocalizationById**](LocalizationsApi.md#getLocalizationById) | **GET** /localizations/{localizationId} | Get Localization Object by ID +[**getDraftLocalizationById**](LocalizationsApi.md#getDraftLocalizationById) | **GET** /localizations/{localizationId}/drafts/{draftId} | Get Draft Localization Object by ID +[**getPublishedLocalizationById**](LocalizationsApi.md#getPublishedLocalizationById) | **GET** /localizations/{localizationId} | Get Localization Object by ID - -# **getLocalizationById** -> LocalizationRead getLocalizationById(localizationId, targetLanguage, accept) + +# **getDraftLocalizationById** +> LocalizationRead getDraftLocalizationById(draftId, localizationId, targetLanguage, accept) + +Get Draft Localization Object by ID + +Returns a specific localization object of the matching draft with a matching localization ID + +### Example +```java +// Import classes: +import io.dyspatch.client.ApiClient; +import io.dyspatch.client.ApiException; +import io.dyspatch.client.Configuration; +import io.dyspatch.client.auth.*; +import io.dyspatch.client.models.*; +import io.dyspatch.client.api.LocalizationsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://api.dyspatch.io"); + + // Configure API key authorization: Bearer + ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer"); + Bearer.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //Bearer.setApiKeyPrefix("Token"); + + LocalizationsApi apiInstance = new LocalizationsApi(defaultClient); + String draftId = "draftId_example"; // String | A draft ID + String localizationId = "localizationId_example"; // String | A localization ID + String targetLanguage = "targetLanguage_example"; // String | The type of templating language to compile as. Should only be used for visual templates. + String 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\" + try { + LocalizationRead result = apiInstance.getDraftLocalizationById(draftId, localizationId, targetLanguage, accept); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LocalizationsApi#getDraftLocalizationById"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **draftId** | **String**| A draft ID | + **localizationId** | **String**| A localization ID | + **targetLanguage** | **String**| The type of templating language to compile as. Should only be used for visual templates. | [enum: html, handlebars, ampscript, freemarker, cheetah, jinja, liquid] + **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\" | + +### Return type + +[**LocalizationRead**](LocalizationRead.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/vnd.dyspatch.2020.11+json, */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | A localization object from the matching draft ID with the requested ID | * X-RateLimit-Remaining - The number of requests left for the current time window
| +**400** | Invalid request | * X-RateLimit-Remaining - The number of requests left for the time window.
| +**401** | Unauthenticated | * X-RateLimit-Remaining - The number of requests left for the time window.
| +**403** | Unauthorized | * X-RateLimit-Remaining - The number of requests left for the time window.
| +**404** | Resource not found | * X-RateLimit-Remaining - The number of requests left for the time window.
| +**429** | Rate limit exceeded | * X-RateLimit-Remaining - The number of requests left for the time window.
| +**500** | Server error | * X-RateLimit-Remaining - The number of requests left for the time window.
| +**0** | Server error | * X-RateLimit-Remaining - The number of requests left for the time window.
| + + +# **getPublishedLocalizationById** +> LocalizationRead getPublishedLocalizationById(localizationId, targetLanguage, accept) Get Localization Object by ID -Returns a specific localization object with a matching ID +Returns the published content associated with the localization of the matching ID ### Example ```java @@ -39,12 +122,12 @@ public class Example { LocalizationsApi apiInstance = new LocalizationsApi(defaultClient); String localizationId = "localizationId_example"; // String | A localization ID String targetLanguage = "targetLanguage_example"; // String | The type of templating language to compile as. Should only be used for visual templates. - String accept = "accept_example"; // String | A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" + String 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\" try { - LocalizationRead result = apiInstance.getLocalizationById(localizationId, targetLanguage, accept); + LocalizationRead result = apiInstance.getPublishedLocalizationById(localizationId, targetLanguage, accept); System.out.println(result); } catch (ApiException e) { - System.err.println("Exception when calling LocalizationsApi#getLocalizationById"); + System.err.println("Exception when calling LocalizationsApi#getPublishedLocalizationById"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -60,7 +143,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **localizationId** | **String**| A localization ID | **targetLanguage** | **String**| The type of templating language to compile as. Should only be used for visual templates. | [enum: html, handlebars, ampscript, freemarker, cheetah, jinja, liquid] - **accept** | **String**| A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" | + **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\" | ### Return type @@ -73,7 +156,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/vnd.dyspatch.2020.08+json, */* + - **Accept**: application/vnd.dyspatch.2020.11+json, */* ### HTTP response details | Status code | Description | Response headers | diff --git a/docs/TemplatesApi.md b/docs/TemplatesApi.md index 0c7f8a3..4fb6523 100644 --- a/docs/TemplatesApi.md +++ b/docs/TemplatesApi.md @@ -40,7 +40,7 @@ public class Example { TemplatesApi apiInstance = new TemplatesApi(defaultClient); String templateId = "templateId_example"; // String | A template ID String targetLanguage = "targetLanguage_example"; // String | The type of templating language to compile as. Should only be used for visual templates. - String accept = "accept_example"; // String | A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" + String 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\" try { TemplateRead result = apiInstance.getTemplateById(templateId, targetLanguage, accept); System.out.println(result); @@ -61,7 +61,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **templateId** | **String**| A template ID | **targetLanguage** | **String**| The type of templating language to compile as. Should only be used for visual templates. | [enum: html, handlebars, ampscript, freemarker, cheetah, jinja, liquid] - **accept** | **String**| A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" | + **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\" | ### Return type @@ -74,7 +74,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/vnd.dyspatch.2020.08+json, */* + - **Accept**: application/vnd.dyspatch.2020.11+json, */* ### HTTP response details | Status code | Description | Response headers | @@ -118,7 +118,7 @@ public class Example { //Bearer.setApiKeyPrefix("Token"); TemplatesApi apiInstance = new TemplatesApi(defaultClient); - String accept = "accept_example"; // String | A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" + String 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\" String cursor = "cursor_example"; // String | A cursor value used to retrieve a specific page from a paginated result set. try { TemplatesRead result = apiInstance.getTemplates(accept, cursor); @@ -138,7 +138,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **accept** | **String**| A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" | + **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\" | **cursor** | **String**| A cursor value used to retrieve a specific page from a paginated result set. | [optional] ### Return type @@ -152,7 +152,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/vnd.dyspatch.2020.08+json, */* + - **Accept**: application/vnd.dyspatch.2020.11+json, */* ### HTTP response details | Status code | Description | Response headers | diff --git a/src/main/java/io/dyspatch/client/ApiCallback.java b/src/main/java/io/dyspatch/client/ApiCallback.java index b620a46..bedd5be 100644 --- a/src/main/java/io/dyspatch/client/ApiCallback.java +++ b/src/main/java/io/dyspatch/client/ApiCallback.java @@ -2,7 +2,7 @@ * Dyspatch API * # 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) * - * The version of the OpenAPI document: 2020.08 + * The version of the OpenAPI document: 2020.11 * Contact: support@dyspatch.io * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/main/java/io/dyspatch/client/ApiClient.java b/src/main/java/io/dyspatch/client/ApiClient.java index 2c8eee3..d1d3ba1 100644 --- a/src/main/java/io/dyspatch/client/ApiClient.java +++ b/src/main/java/io/dyspatch/client/ApiClient.java @@ -2,7 +2,7 @@ * Dyspatch API * # 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) * - * The version of the OpenAPI document: 2020.08 + * The version of the OpenAPI document: 2020.11 * Contact: support@dyspatch.io * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/main/java/io/dyspatch/client/ApiException.java b/src/main/java/io/dyspatch/client/ApiException.java index f3d3ac6..5001a3e 100644 --- a/src/main/java/io/dyspatch/client/ApiException.java +++ b/src/main/java/io/dyspatch/client/ApiException.java @@ -2,7 +2,7 @@ * Dyspatch API * # 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) * - * The version of the OpenAPI document: 2020.08 + * The version of the OpenAPI document: 2020.11 * Contact: support@dyspatch.io * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/main/java/io/dyspatch/client/ApiResponse.java b/src/main/java/io/dyspatch/client/ApiResponse.java index b0605d2..37161f5 100644 --- a/src/main/java/io/dyspatch/client/ApiResponse.java +++ b/src/main/java/io/dyspatch/client/ApiResponse.java @@ -2,7 +2,7 @@ * Dyspatch API * # 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) * - * The version of the OpenAPI document: 2020.08 + * The version of the OpenAPI document: 2020.11 * Contact: support@dyspatch.io * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/main/java/io/dyspatch/client/Configuration.java b/src/main/java/io/dyspatch/client/Configuration.java index 32ddf35..599740c 100644 --- a/src/main/java/io/dyspatch/client/Configuration.java +++ b/src/main/java/io/dyspatch/client/Configuration.java @@ -2,7 +2,7 @@ * Dyspatch API * # 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) * - * The version of the OpenAPI document: 2020.08 + * The version of the OpenAPI document: 2020.11 * Contact: support@dyspatch.io * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/main/java/io/dyspatch/client/GzipRequestInterceptor.java b/src/main/java/io/dyspatch/client/GzipRequestInterceptor.java index 6e57fe7..b65f167 100644 --- a/src/main/java/io/dyspatch/client/GzipRequestInterceptor.java +++ b/src/main/java/io/dyspatch/client/GzipRequestInterceptor.java @@ -2,7 +2,7 @@ * Dyspatch API * # 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) * - * The version of the OpenAPI document: 2020.08 + * The version of the OpenAPI document: 2020.11 * Contact: support@dyspatch.io * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/main/java/io/dyspatch/client/JSON.java b/src/main/java/io/dyspatch/client/JSON.java index f02796b..4fa990d 100644 --- a/src/main/java/io/dyspatch/client/JSON.java +++ b/src/main/java/io/dyspatch/client/JSON.java @@ -2,7 +2,7 @@ * Dyspatch API * # 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) * - * The version of the OpenAPI document: 2020.08 + * The version of the OpenAPI document: 2020.11 * Contact: support@dyspatch.io * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/main/java/io/dyspatch/client/Pair.java b/src/main/java/io/dyspatch/client/Pair.java index a295f3d..f9a02c9 100644 --- a/src/main/java/io/dyspatch/client/Pair.java +++ b/src/main/java/io/dyspatch/client/Pair.java @@ -2,7 +2,7 @@ * Dyspatch API * # 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) * - * The version of the OpenAPI document: 2020.08 + * The version of the OpenAPI document: 2020.11 * Contact: support@dyspatch.io * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/main/java/io/dyspatch/client/ProgressRequestBody.java b/src/main/java/io/dyspatch/client/ProgressRequestBody.java index dc74c05..f3ad483 100644 --- a/src/main/java/io/dyspatch/client/ProgressRequestBody.java +++ b/src/main/java/io/dyspatch/client/ProgressRequestBody.java @@ -2,7 +2,7 @@ * Dyspatch API * # 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) * - * The version of the OpenAPI document: 2020.08 + * The version of the OpenAPI document: 2020.11 * Contact: support@dyspatch.io * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/main/java/io/dyspatch/client/ProgressResponseBody.java b/src/main/java/io/dyspatch/client/ProgressResponseBody.java index 5e4b48f..cbbc3ec 100644 --- a/src/main/java/io/dyspatch/client/ProgressResponseBody.java +++ b/src/main/java/io/dyspatch/client/ProgressResponseBody.java @@ -2,7 +2,7 @@ * Dyspatch API * # 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) * - * The version of the OpenAPI document: 2020.08 + * The version of the OpenAPI document: 2020.11 * Contact: support@dyspatch.io * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/main/java/io/dyspatch/client/StringUtil.java b/src/main/java/io/dyspatch/client/StringUtil.java index 5bc669b..4d2cf58 100644 --- a/src/main/java/io/dyspatch/client/StringUtil.java +++ b/src/main/java/io/dyspatch/client/StringUtil.java @@ -2,7 +2,7 @@ * Dyspatch API * # 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) * - * The version of the OpenAPI document: 2020.08 + * The version of the OpenAPI document: 2020.11 * Contact: support@dyspatch.io * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/main/java/io/dyspatch/client/api/DraftsApi.java b/src/main/java/io/dyspatch/client/api/DraftsApi.java index 8477ef6..2d9f126 100644 --- a/src/main/java/io/dyspatch/client/api/DraftsApi.java +++ b/src/main/java/io/dyspatch/client/api/DraftsApi.java @@ -2,7 +2,7 @@ * Dyspatch API * # 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) * - * The version of the OpenAPI document: 2020.08 + * The version of the OpenAPI document: 2020.11 * Contact: support@dyspatch.io * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -63,7 +63,7 @@ public void setApiClient(ApiClient apiClient) { * Build call for deleteLocalization * @param draftId A draft ID (required) * @param languageId A language ID (eg: en-US) (required) - * @param accept A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" (required) + * @param accept 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\" (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -91,7 +91,7 @@ public okhttp3.Call deleteLocalizationCall(String draftId, String languageId, St Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { - "application/vnd.dyspatch.2020.08+json", "*/*" + "application/vnd.dyspatch.2020.11+json", "*/*" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { @@ -137,7 +137,7 @@ private okhttp3.Call deleteLocalizationValidateBeforeCall(String draftId, String * Deletes the localization with the given language ID if it exists * @param draftId A draft ID (required) * @param languageId A language ID (eg: en-US) (required) - * @param accept A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" (required) + * @param accept 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\" (required) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -154,7 +154,7 @@ public void deleteLocalization(String draftId, String languageId, String accept) * Deletes the localization with the given language ID if it exists * @param draftId A draft ID (required) * @param languageId A language ID (eg: en-US) (required) - * @param accept A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" (required) + * @param accept 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\" (required) * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -173,7 +173,7 @@ public ApiResponse deleteLocalizationWithHttpInfo(String draftId, String l * Deletes the localization with the given language ID if it exists * @param draftId A draft ID (required) * @param languageId A language ID (eg: en-US) (required) - * @param accept A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" (required) + * @param accept 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\" (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -193,7 +193,7 @@ public okhttp3.Call deleteLocalizationAsync(String draftId, String languageId, S * Build call for getDraftById * @param draftId A draft ID (required) * @param targetLanguage The type of templating language to compile as. Should only be used for visual templates. (required) - * @param accept A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" (required) + * @param accept 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\" (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -231,7 +231,7 @@ public okhttp3.Call getDraftByIdCall(String draftId, String targetLanguage, Stri Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { - "application/vnd.dyspatch.2020.08+json", "*/*" + "application/vnd.dyspatch.2020.11+json", "*/*" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { @@ -277,7 +277,7 @@ private okhttp3.Call getDraftByIdValidateBeforeCall(String draftId, String targe * Gets a draft object with the matching ID. The \"compiled\" field will contain the template in the default, unlocalized form. * @param draftId A draft ID (required) * @param targetLanguage The type of templating language to compile as. Should only be used for visual templates. (required) - * @param accept A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" (required) + * @param accept 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\" (required) * @return DraftRead * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -303,7 +303,7 @@ public DraftRead getDraftById(String draftId, String targetLanguage, String acce * Gets a draft object with the matching ID. The \"compiled\" field will contain the template in the default, unlocalized form. * @param draftId A draft ID (required) * @param targetLanguage The type of templating language to compile as. Should only be used for visual templates. (required) - * @param accept A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" (required) + * @param accept 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\" (required) * @return ApiResponse<DraftRead> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -330,7 +330,7 @@ public ApiResponse getDraftByIdWithHttpInfo(String draftId, String ta * Gets a draft object with the matching ID. The \"compiled\" field will contain the template in the default, unlocalized form. * @param draftId A draft ID (required) * @param targetLanguage The type of templating language to compile as. Should only be used for visual templates. (required) - * @param accept A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" (required) + * @param accept 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\" (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -357,7 +357,7 @@ public okhttp3.Call getDraftByIdAsync(String draftId, String targetLanguage, Str /** * Build call for getDraftLocalizationKeys * @param draftId A draft ID (required) - * @param accept A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" (required) + * @param accept 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\" (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -384,7 +384,7 @@ public okhttp3.Call getDraftLocalizationKeysCall(String draftId, String accept, Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { - "application/vnd.dyspatch.2020.08+json", "*/*" + "application/vnd.dyspatch.2020.11+json", "*/*" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { @@ -422,9 +422,9 @@ private okhttp3.Call getDraftLocalizationKeysValidateBeforeCall(String draftId, /** * Get localization keys - * Returns the list of values that need to be translated for the draft. Set the `Accept` header to `application/vnd.dyspatch.2020.08+json` to get a JSON object, or `text/vnd.dyspatch.2020.08+x-gettext-translation` to get the POT file. + * 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. * @param draftId A draft ID (required) - * @param accept A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" (required) + * @param accept 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\" (required) * @return List<LocalizationKeyRead> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -440,9 +440,9 @@ public List getDraftLocalizationKeys(String draftId, String /** * Get localization keys - * Returns the list of values that need to be translated for the draft. Set the `Accept` header to `application/vnd.dyspatch.2020.08+json` to get a JSON object, or `text/vnd.dyspatch.2020.08+x-gettext-translation` to get the POT file. + * 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. * @param draftId A draft ID (required) - * @param accept A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" (required) + * @param accept 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\" (required) * @return ApiResponse<List<LocalizationKeyRead>> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -459,9 +459,9 @@ public ApiResponse> getDraftLocalizationKeysWithHttpIn /** * Get localization keys (asynchronously) - * Returns the list of values that need to be translated for the draft. Set the `Accept` header to `application/vnd.dyspatch.2020.08+json` to get a JSON object, or `text/vnd.dyspatch.2020.08+x-gettext-translation` to get the POT file. + * 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. * @param draftId A draft ID (required) - * @param accept A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" (required) + * @param accept 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\" (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -480,7 +480,7 @@ public okhttp3.Call getDraftLocalizationKeysAsync(String draftId, String accept, } /** * Build call for getDrafts - * @param accept A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" (required) + * @param accept 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\" (required) * @param cursor A cursor value used to retrieve a specific page from a paginated result set. (optional) * @param status Filter the list of drafts by a particular status (optional) * @param _callback Callback for upload/download progress @@ -523,7 +523,7 @@ public okhttp3.Call getDraftsCall(String accept, String cursor, String status, f Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { - "application/vnd.dyspatch.2020.08+json", "*/*" + "application/vnd.dyspatch.2020.11+json", "*/*" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { @@ -557,7 +557,7 @@ private okhttp3.Call getDraftsValidateBeforeCall(String accept, String cursor, S /** * List Drafts * Returns all drafts for your organization. - * @param accept A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" (required) + * @param accept 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\" (required) * @param cursor A cursor value used to retrieve a specific page from a paginated result set. (optional) * @param status Filter the list of drafts by a particular status (optional) * @return DraftsRead @@ -583,7 +583,7 @@ public DraftsRead getDrafts(String accept, String cursor, String status) throws /** * List Drafts * Returns all drafts for your organization. - * @param accept A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" (required) + * @param accept 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\" (required) * @param cursor A cursor value used to retrieve a specific page from a paginated result set. (optional) * @param status Filter the list of drafts by a particular status (optional) * @return ApiResponse<DraftsRead> @@ -610,7 +610,7 @@ public ApiResponse getDraftsWithHttpInfo(String accept, String curso /** * List Drafts (asynchronously) * Returns all drafts for your organization. - * @param accept A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" (required) + * @param accept 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\" (required) * @param cursor A cursor value used to retrieve a specific page from a paginated result set. (optional) * @param status Filter the list of drafts by a particular status (optional) * @param _callback The callback to be executed when the API call finishes @@ -639,7 +639,7 @@ public okhttp3.Call getDraftsAsync(String accept, String cursor, String status, /** * Build call for getLocalizationForDraft * @param draftId A draft ID (required) - * @param accept A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" (required) + * @param accept 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\" (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -666,7 +666,7 @@ public okhttp3.Call getLocalizationForDraftCall(String draftId, String accept, f Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { - "application/vnd.dyspatch.2020.08+json", "*/*" + "application/vnd.dyspatch.2020.11+json", "*/*" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { @@ -706,7 +706,7 @@ private okhttp3.Call getLocalizationForDraftValidateBeforeCall(String draftId, S * Get localizations on a draft * Returns localization metadata for the draft * @param draftId A draft ID (required) - * @param accept A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" (required) + * @param accept 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\" (required) * @return List<LocalizationMetaRead> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -724,7 +724,7 @@ public List getLocalizationForDraft(String draftId, String * Get localizations on a draft * Returns localization metadata for the draft * @param draftId A draft ID (required) - * @param accept A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" (required) + * @param accept 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\" (required) * @return ApiResponse<List<LocalizationMetaRead>> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -743,7 +743,7 @@ public ApiResponse> getLocalizationForDraftWithHttpIn * Get localizations on a draft (asynchronously) * Returns localization metadata for the draft * @param draftId A draft ID (required) - * @param accept A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" (required) + * @param accept 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\" (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -764,7 +764,7 @@ public okhttp3.Call getLocalizationForDraftAsync(String draftId, String accept, * Build call for saveLocalization * @param draftId A draft ID (required) * @param languageId A language ID (eg: en-US) (required) - * @param accept A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" (required) + * @param accept 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\" (required) * @param inlineObject (required) * @param _callback Callback for upload/download progress * @return Call to execute @@ -793,7 +793,7 @@ public okhttp3.Call saveLocalizationCall(String draftId, String languageId, Stri Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { - "application/vnd.dyspatch.2020.08+json", "*/*" + "application/vnd.dyspatch.2020.11+json", "*/*" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { @@ -844,7 +844,7 @@ private okhttp3.Call saveLocalizationValidateBeforeCall(String draftId, String l * Inserts a localization or sets the name on an existing localization that already uses the languageId * @param draftId A draft ID (required) * @param languageId A language ID (eg: en-US) (required) - * @param accept A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" (required) + * @param accept 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\" (required) * @param inlineObject (required) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -862,7 +862,7 @@ public void saveLocalization(String draftId, String languageId, String accept, I * Inserts a localization or sets the name on an existing localization that already uses the languageId * @param draftId A draft ID (required) * @param languageId A language ID (eg: en-US) (required) - * @param accept A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" (required) + * @param accept 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\" (required) * @param inlineObject (required) * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -882,7 +882,7 @@ public ApiResponse saveLocalizationWithHttpInfo(String draftId, String lan * Inserts a localization or sets the name on an existing localization that already uses the languageId * @param draftId A draft ID (required) * @param languageId A language ID (eg: en-US) (required) - * @param accept A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" (required) + * @param accept 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\" (required) * @param inlineObject (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -903,7 +903,7 @@ public okhttp3.Call saveLocalizationAsync(String draftId, String languageId, Str * Build call for setTranslation * @param draftId A draft ID (required) * @param languageId A language ID (eg: en-US) (required) - * @param accept A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" (required) + * @param accept 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\" (required) * @param requestBody (required) * @param _callback Callback for upload/download progress * @return Call to execute @@ -933,7 +933,7 @@ public okhttp3.Call setTranslationCall(String draftId, String languageId, String Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { - "application/vnd.dyspatch.2020.08+json", "*/*" + "application/vnd.dyspatch.2020.11+json", "*/*" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { @@ -984,7 +984,7 @@ private okhttp3.Call setTranslationValidateBeforeCall(String draftId, String lan * Completely replaces any existing translations for the given language with those provided in request body. Variables embedded in keys or values are expected to be in the format `%(my_variable)s` and will automatically convert to the correct Dyspatch format depending on the type of template. Accepts key/value pairs in JSON format or in gettext PO file format. For JSON set `Content-Type` header to `application/json`. For gettext PO format set `Content-Type` header to `text/x-gettext-translation`. * @param draftId A draft ID (required) * @param languageId A language ID (eg: en-US) (required) - * @param accept A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" (required) + * @param accept 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\" (required) * @param requestBody (required) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -1003,7 +1003,7 @@ public void setTranslation(String draftId, String languageId, String accept, Map * Completely replaces any existing translations for the given language with those provided in request body. Variables embedded in keys or values are expected to be in the format `%(my_variable)s` and will automatically convert to the correct Dyspatch format depending on the type of template. Accepts key/value pairs in JSON format or in gettext PO file format. For JSON set `Content-Type` header to `application/json`. For gettext PO format set `Content-Type` header to `text/x-gettext-translation`. * @param draftId A draft ID (required) * @param languageId A language ID (eg: en-US) (required) - * @param accept A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" (required) + * @param accept 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\" (required) * @param requestBody (required) * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -1024,7 +1024,7 @@ public ApiResponse setTranslationWithHttpInfo(String draftId, String langu * Completely replaces any existing translations for the given language with those provided in request body. Variables embedded in keys or values are expected to be in the format `%(my_variable)s` and will automatically convert to the correct Dyspatch format depending on the type of template. Accepts key/value pairs in JSON format or in gettext PO file format. For JSON set `Content-Type` header to `application/json`. For gettext PO format set `Content-Type` header to `text/x-gettext-translation`. * @param draftId A draft ID (required) * @param languageId A language ID (eg: en-US) (required) - * @param accept A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" (required) + * @param accept 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\" (required) * @param requestBody (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -1045,7 +1045,7 @@ public okhttp3.Call setTranslationAsync(String draftId, String languageId, Strin /** * Build call for submitDraftForApproval * @param draftId A draft ID (required) - * @param accept A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" (required) + * @param accept 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\" (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -1079,7 +1079,7 @@ public okhttp3.Call submitDraftForApprovalCall(String draftId, String accept, fi Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { - "application/vnd.dyspatch.2020.08+json", "*/*" + "application/vnd.dyspatch.2020.11+json", "*/*" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { @@ -1119,7 +1119,7 @@ private okhttp3.Call submitDraftForApprovalValidateBeforeCall(String draftId, St * Submit the draft for approval * Moves the draft into submitted state. * @param draftId A draft ID (required) - * @param accept A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" (required) + * @param accept 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\" (required) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
@@ -1142,7 +1142,7 @@ public void submitDraftForApproval(String draftId, String accept) throws ApiExce * Submit the draft for approval * Moves the draft into submitted state. * @param draftId A draft ID (required) - * @param accept A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" (required) + * @param accept 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\" (required) * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -1167,7 +1167,7 @@ public ApiResponse submitDraftForApprovalWithHttpInfo(String draftId, Stri * Submit the draft for approval (asynchronously) * Moves the draft into submitted state. * @param draftId A draft ID (required) - * @param accept A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" (required) + * @param accept 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\" (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object diff --git a/src/main/java/io/dyspatch/client/api/LocalizationsApi.java b/src/main/java/io/dyspatch/client/api/LocalizationsApi.java index 53f2f36..115fa82 100644 --- a/src/main/java/io/dyspatch/client/api/LocalizationsApi.java +++ b/src/main/java/io/dyspatch/client/api/LocalizationsApi.java @@ -2,7 +2,7 @@ * Dyspatch API * # 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) * - * The version of the OpenAPI document: 2020.08 + * The version of the OpenAPI document: 2020.11 * Contact: support@dyspatch.io * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -56,10 +56,185 @@ public void setApiClient(ApiClient apiClient) { } /** - * Build call for getLocalizationById + * Build call for getDraftLocalizationById + * @param draftId A draft ID (required) * @param localizationId A localization ID (required) * @param targetLanguage The type of templating language to compile as. Should only be used for visual templates. (required) - * @param accept A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" (required) + * @param accept 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\" (required) + * @param _callback Callback for upload/download progress + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + * @http.response.details +
+ + + + + + + + + +
Status Code Description Response Headers
200 A localization object from the matching draft ID with the requested ID * X-RateLimit-Remaining - The number of requests left for the current time window
400 Invalid request * X-RateLimit-Remaining - The number of requests left for the time window.
401 Unauthenticated * X-RateLimit-Remaining - The number of requests left for the time window.
403 Unauthorized * X-RateLimit-Remaining - The number of requests left for the time window.
404 Resource not found * X-RateLimit-Remaining - The number of requests left for the time window.
429 Rate limit exceeded * X-RateLimit-Remaining - The number of requests left for the time window.
500 Server error * X-RateLimit-Remaining - The number of requests left for the time window.
0 Server error * X-RateLimit-Remaining - The number of requests left for the time window.
+ */ + public okhttp3.Call getDraftLocalizationByIdCall(String draftId, String localizationId, String targetLanguage, String accept, final ApiCallback _callback) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/localizations/{localizationId}/drafts/{draftId}" + .replaceAll("\\{" + "draftId" + "\\}", localVarApiClient.escapeString(draftId.toString())) + .replaceAll("\\{" + "localizationId" + "\\}", localVarApiClient.escapeString(localizationId.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + if (targetLanguage != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("targetLanguage", targetLanguage)); + } + + Map localVarHeaderParams = new HashMap(); + if (accept != null) { + localVarHeaderParams.put("Accept", localVarApiClient.parameterToString(accept)); + } + + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + final String[] localVarAccepts = { + "application/vnd.dyspatch.2020.11+json", "*/*" + }; + final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) { + localVarHeaderParams.put("Accept", localVarAccept); + } + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + String[] localVarAuthNames = new String[] { "Bearer" }; + return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call getDraftLocalizationByIdValidateBeforeCall(String draftId, String localizationId, String targetLanguage, String accept, final ApiCallback _callback) throws ApiException { + + // verify the required parameter 'draftId' is set + if (draftId == null) { + throw new ApiException("Missing the required parameter 'draftId' when calling getDraftLocalizationById(Async)"); + } + + // verify the required parameter 'localizationId' is set + if (localizationId == null) { + throw new ApiException("Missing the required parameter 'localizationId' when calling getDraftLocalizationById(Async)"); + } + + // verify the required parameter 'targetLanguage' is set + if (targetLanguage == null) { + throw new ApiException("Missing the required parameter 'targetLanguage' when calling getDraftLocalizationById(Async)"); + } + + // verify the required parameter 'accept' is set + if (accept == null) { + throw new ApiException("Missing the required parameter 'accept' when calling getDraftLocalizationById(Async)"); + } + + + okhttp3.Call localVarCall = getDraftLocalizationByIdCall(draftId, localizationId, targetLanguage, accept, _callback); + return localVarCall; + + } + + /** + * Get Draft Localization Object by ID + * Returns a specific localization object of the matching draft with a matching localization ID + * @param draftId A draft ID (required) + * @param localizationId A localization ID (required) + * @param targetLanguage The type of templating language to compile as. Should only be used for visual templates. (required) + * @param accept 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\" (required) + * @return LocalizationRead + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + + + + +
Status Code Description Response Headers
200 A localization object from the matching draft ID with the requested ID * X-RateLimit-Remaining - The number of requests left for the current time window
400 Invalid request * X-RateLimit-Remaining - The number of requests left for the time window.
401 Unauthenticated * X-RateLimit-Remaining - The number of requests left for the time window.
403 Unauthorized * X-RateLimit-Remaining - The number of requests left for the time window.
404 Resource not found * X-RateLimit-Remaining - The number of requests left for the time window.
429 Rate limit exceeded * X-RateLimit-Remaining - The number of requests left for the time window.
500 Server error * X-RateLimit-Remaining - The number of requests left for the time window.
0 Server error * X-RateLimit-Remaining - The number of requests left for the time window.
+ */ + public LocalizationRead getDraftLocalizationById(String draftId, String localizationId, String targetLanguage, String accept) throws ApiException { + ApiResponse localVarResp = getDraftLocalizationByIdWithHttpInfo(draftId, localizationId, targetLanguage, accept); + return localVarResp.getData(); + } + + /** + * Get Draft Localization Object by ID + * Returns a specific localization object of the matching draft with a matching localization ID + * @param draftId A draft ID (required) + * @param localizationId A localization ID (required) + * @param targetLanguage The type of templating language to compile as. Should only be used for visual templates. (required) + * @param accept 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\" (required) + * @return ApiResponse<LocalizationRead> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + + + + +
Status Code Description Response Headers
200 A localization object from the matching draft ID with the requested ID * X-RateLimit-Remaining - The number of requests left for the current time window
400 Invalid request * X-RateLimit-Remaining - The number of requests left for the time window.
401 Unauthenticated * X-RateLimit-Remaining - The number of requests left for the time window.
403 Unauthorized * X-RateLimit-Remaining - The number of requests left for the time window.
404 Resource not found * X-RateLimit-Remaining - The number of requests left for the time window.
429 Rate limit exceeded * X-RateLimit-Remaining - The number of requests left for the time window.
500 Server error * X-RateLimit-Remaining - The number of requests left for the time window.
0 Server error * X-RateLimit-Remaining - The number of requests left for the time window.
+ */ + public ApiResponse getDraftLocalizationByIdWithHttpInfo(String draftId, String localizationId, String targetLanguage, String accept) throws ApiException { + okhttp3.Call localVarCall = getDraftLocalizationByIdValidateBeforeCall(draftId, localizationId, targetLanguage, accept, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * Get Draft Localization Object by ID (asynchronously) + * Returns a specific localization object of the matching draft with a matching localization ID + * @param draftId A draft ID (required) + * @param localizationId A localization ID (required) + * @param targetLanguage The type of templating language to compile as. Should only be used for visual templates. (required) + * @param accept 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\" (required) + * @param _callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + * @http.response.details + + + + + + + + + + +
Status Code Description Response Headers
200 A localization object from the matching draft ID with the requested ID * X-RateLimit-Remaining - The number of requests left for the current time window
400 Invalid request * X-RateLimit-Remaining - The number of requests left for the time window.
401 Unauthenticated * X-RateLimit-Remaining - The number of requests left for the time window.
403 Unauthorized * X-RateLimit-Remaining - The number of requests left for the time window.
404 Resource not found * X-RateLimit-Remaining - The number of requests left for the time window.
429 Rate limit exceeded * X-RateLimit-Remaining - The number of requests left for the time window.
500 Server error * X-RateLimit-Remaining - The number of requests left for the time window.
0 Server error * X-RateLimit-Remaining - The number of requests left for the time window.
+ */ + public okhttp3.Call getDraftLocalizationByIdAsync(String draftId, String localizationId, String targetLanguage, String accept, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = getDraftLocalizationByIdValidateBeforeCall(draftId, localizationId, targetLanguage, accept, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } + /** + * Build call for getPublishedLocalizationById + * @param localizationId A localization ID (required) + * @param targetLanguage The type of templating language to compile as. Should only be used for visual templates. (required) + * @param accept 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\" (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -76,7 +251,7 @@ public void setApiClient(ApiClient apiClient) { 0 Server error * X-RateLimit-Remaining - The number of requests left for the time window.
*/ - public okhttp3.Call getLocalizationByIdCall(String localizationId, String targetLanguage, String accept, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getPublishedLocalizationByIdCall(String localizationId, String targetLanguage, String accept, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables @@ -97,7 +272,7 @@ public okhttp3.Call getLocalizationByIdCall(String localizationId, String target Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { - "application/vnd.dyspatch.2020.08+json", "*/*" + "application/vnd.dyspatch.2020.11+json", "*/*" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { @@ -115,35 +290,35 @@ public okhttp3.Call getLocalizationByIdCall(String localizationId, String target } @SuppressWarnings("rawtypes") - private okhttp3.Call getLocalizationByIdValidateBeforeCall(String localizationId, String targetLanguage, String accept, final ApiCallback _callback) throws ApiException { + private okhttp3.Call getPublishedLocalizationByIdValidateBeforeCall(String localizationId, String targetLanguage, String accept, final ApiCallback _callback) throws ApiException { // verify the required parameter 'localizationId' is set if (localizationId == null) { - throw new ApiException("Missing the required parameter 'localizationId' when calling getLocalizationById(Async)"); + throw new ApiException("Missing the required parameter 'localizationId' when calling getPublishedLocalizationById(Async)"); } // verify the required parameter 'targetLanguage' is set if (targetLanguage == null) { - throw new ApiException("Missing the required parameter 'targetLanguage' when calling getLocalizationById(Async)"); + throw new ApiException("Missing the required parameter 'targetLanguage' when calling getPublishedLocalizationById(Async)"); } // verify the required parameter 'accept' is set if (accept == null) { - throw new ApiException("Missing the required parameter 'accept' when calling getLocalizationById(Async)"); + throw new ApiException("Missing the required parameter 'accept' when calling getPublishedLocalizationById(Async)"); } - okhttp3.Call localVarCall = getLocalizationByIdCall(localizationId, targetLanguage, accept, _callback); + okhttp3.Call localVarCall = getPublishedLocalizationByIdCall(localizationId, targetLanguage, accept, _callback); return localVarCall; } /** * Get Localization Object by ID - * Returns a specific localization object with a matching ID + * Returns the published content associated with the localization of the matching ID * @param localizationId A localization ID (required) * @param targetLanguage The type of templating language to compile as. Should only be used for visual templates. (required) - * @param accept A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" (required) + * @param accept 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\" (required) * @return LocalizationRead * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -159,17 +334,17 @@ private okhttp3.Call getLocalizationByIdValidateBeforeCall(String localizationId 0 Server error * X-RateLimit-Remaining - The number of requests left for the time window.
*/ - public LocalizationRead getLocalizationById(String localizationId, String targetLanguage, String accept) throws ApiException { - ApiResponse localVarResp = getLocalizationByIdWithHttpInfo(localizationId, targetLanguage, accept); + public LocalizationRead getPublishedLocalizationById(String localizationId, String targetLanguage, String accept) throws ApiException { + ApiResponse localVarResp = getPublishedLocalizationByIdWithHttpInfo(localizationId, targetLanguage, accept); return localVarResp.getData(); } /** * Get Localization Object by ID - * Returns a specific localization object with a matching ID + * Returns the published content associated with the localization of the matching ID * @param localizationId A localization ID (required) * @param targetLanguage The type of templating language to compile as. Should only be used for visual templates. (required) - * @param accept A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" (required) + * @param accept 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\" (required) * @return ApiResponse<LocalizationRead> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -185,18 +360,18 @@ public LocalizationRead getLocalizationById(String localizationId, String target 0 Server error * X-RateLimit-Remaining - The number of requests left for the time window.
*/ - public ApiResponse getLocalizationByIdWithHttpInfo(String localizationId, String targetLanguage, String accept) throws ApiException { - okhttp3.Call localVarCall = getLocalizationByIdValidateBeforeCall(localizationId, targetLanguage, accept, null); + public ApiResponse getPublishedLocalizationByIdWithHttpInfo(String localizationId, String targetLanguage, String accept) throws ApiException { + okhttp3.Call localVarCall = getPublishedLocalizationByIdValidateBeforeCall(localizationId, targetLanguage, accept, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** * Get Localization Object by ID (asynchronously) - * Returns a specific localization object with a matching ID + * Returns the published content associated with the localization of the matching ID * @param localizationId A localization ID (required) * @param targetLanguage The type of templating language to compile as. Should only be used for visual templates. (required) - * @param accept A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" (required) + * @param accept 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\" (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -213,9 +388,9 @@ public ApiResponse getLocalizationByIdWithHttpInfo(String loca 0 Server error * X-RateLimit-Remaining - The number of requests left for the time window.
*/ - public okhttp3.Call getLocalizationByIdAsync(String localizationId, String targetLanguage, String accept, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getPublishedLocalizationByIdAsync(String localizationId, String targetLanguage, String accept, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getLocalizationByIdValidateBeforeCall(localizationId, targetLanguage, accept, _callback); + okhttp3.Call localVarCall = getPublishedLocalizationByIdValidateBeforeCall(localizationId, targetLanguage, accept, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; diff --git a/src/main/java/io/dyspatch/client/api/TemplatesApi.java b/src/main/java/io/dyspatch/client/api/TemplatesApi.java index 10e6e3d..c08120b 100644 --- a/src/main/java/io/dyspatch/client/api/TemplatesApi.java +++ b/src/main/java/io/dyspatch/client/api/TemplatesApi.java @@ -2,7 +2,7 @@ * Dyspatch API * # 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) * - * The version of the OpenAPI document: 2020.08 + * The version of the OpenAPI document: 2020.11 * Contact: support@dyspatch.io * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -60,7 +60,7 @@ public void setApiClient(ApiClient apiClient) { * Build call for getTemplateById * @param templateId A template ID (required) * @param targetLanguage The type of templating language to compile as. Should only be used for visual templates. (required) - * @param accept A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" (required) + * @param accept 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\" (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -98,7 +98,7 @@ public okhttp3.Call getTemplateByIdCall(String templateId, String targetLanguage Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { - "application/vnd.dyspatch.2020.08+json", "*/*" + "application/vnd.dyspatch.2020.11+json", "*/*" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { @@ -144,7 +144,7 @@ private okhttp3.Call getTemplateByIdValidateBeforeCall(String templateId, String * Gets a template object with the matching ID. If the template has published content the \"compiled\" field will contain the template . * @param templateId A template ID (required) * @param targetLanguage The type of templating language to compile as. Should only be used for visual templates. (required) - * @param accept A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" (required) + * @param accept 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\" (required) * @return TemplateRead * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -170,7 +170,7 @@ public TemplateRead getTemplateById(String templateId, String targetLanguage, St * Gets a template object with the matching ID. If the template has published content the \"compiled\" field will contain the template . * @param templateId A template ID (required) * @param targetLanguage The type of templating language to compile as. Should only be used for visual templates. (required) - * @param accept A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" (required) + * @param accept 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\" (required) * @return ApiResponse<TemplateRead> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -197,7 +197,7 @@ public ApiResponse getTemplateByIdWithHttpInfo(String templateId, * Gets a template object with the matching ID. If the template has published content the \"compiled\" field will contain the template . * @param templateId A template ID (required) * @param targetLanguage The type of templating language to compile as. Should only be used for visual templates. (required) - * @param accept A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" (required) + * @param accept 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\" (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -223,7 +223,7 @@ public okhttp3.Call getTemplateByIdAsync(String templateId, String targetLanguag } /** * Build call for getTemplates - * @param accept A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" (required) + * @param accept 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\" (required) * @param cursor A cursor value used to retrieve a specific page from a paginated result set. (optional) * @param _callback Callback for upload/download progress * @return Call to execute @@ -260,7 +260,7 @@ public okhttp3.Call getTemplatesCall(String accept, String cursor, final ApiCall Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { - "application/vnd.dyspatch.2020.08+json", "*/*" + "application/vnd.dyspatch.2020.11+json", "*/*" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { @@ -294,7 +294,7 @@ private okhttp3.Call getTemplatesValidateBeforeCall(String accept, String cursor /** * List Templates * Gets a list of Template Metadata objects for all templates. Up to 25 results returned before results are paginated. - * @param accept A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" (required) + * @param accept 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\" (required) * @param cursor A cursor value used to retrieve a specific page from a paginated result set. (optional) * @return TemplatesRead * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -318,7 +318,7 @@ public TemplatesRead getTemplates(String accept, String cursor) throws ApiExcept /** * List Templates * Gets a list of Template Metadata objects for all templates. Up to 25 results returned before results are paginated. - * @param accept A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" (required) + * @param accept 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\" (required) * @param cursor A cursor value used to retrieve a specific page from a paginated result set. (optional) * @return ApiResponse<TemplatesRead> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -343,7 +343,7 @@ public ApiResponse getTemplatesWithHttpInfo(String accept, String /** * List Templates (asynchronously) * Gets a list of Template Metadata objects for all templates. Up to 25 results returned before results are paginated. - * @param accept A version of the API that should be used for the request. For example, to use version \"2020.08\", set the value to \"application/vnd.dyspatch.2020.08+json\" (required) + * @param accept 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\" (required) * @param cursor A cursor value used to retrieve a specific page from a paginated result set. (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call diff --git a/src/main/java/io/dyspatch/client/auth/ApiKeyAuth.java b/src/main/java/io/dyspatch/client/auth/ApiKeyAuth.java index d44270a..aa629c7 100644 --- a/src/main/java/io/dyspatch/client/auth/ApiKeyAuth.java +++ b/src/main/java/io/dyspatch/client/auth/ApiKeyAuth.java @@ -2,7 +2,7 @@ * Dyspatch API * # 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) * - * The version of the OpenAPI document: 2020.08 + * The version of the OpenAPI document: 2020.11 * Contact: support@dyspatch.io * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/main/java/io/dyspatch/client/auth/Authentication.java b/src/main/java/io/dyspatch/client/auth/Authentication.java index 32b7a6b..a6f9973 100644 --- a/src/main/java/io/dyspatch/client/auth/Authentication.java +++ b/src/main/java/io/dyspatch/client/auth/Authentication.java @@ -2,7 +2,7 @@ * Dyspatch API * # 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) * - * The version of the OpenAPI document: 2020.08 + * The version of the OpenAPI document: 2020.11 * Contact: support@dyspatch.io * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/main/java/io/dyspatch/client/auth/HttpBasicAuth.java b/src/main/java/io/dyspatch/client/auth/HttpBasicAuth.java index 0977775..8ac360c 100644 --- a/src/main/java/io/dyspatch/client/auth/HttpBasicAuth.java +++ b/src/main/java/io/dyspatch/client/auth/HttpBasicAuth.java @@ -2,7 +2,7 @@ * Dyspatch API * # 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) * - * The version of the OpenAPI document: 2020.08 + * The version of the OpenAPI document: 2020.11 * Contact: support@dyspatch.io * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/main/java/io/dyspatch/client/auth/HttpBearerAuth.java b/src/main/java/io/dyspatch/client/auth/HttpBearerAuth.java index 133b3bb..055dc33 100644 --- a/src/main/java/io/dyspatch/client/auth/HttpBearerAuth.java +++ b/src/main/java/io/dyspatch/client/auth/HttpBearerAuth.java @@ -2,7 +2,7 @@ * Dyspatch API * # 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) * - * The version of the OpenAPI document: 2020.08 + * The version of the OpenAPI document: 2020.11 * Contact: support@dyspatch.io * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/main/java/io/dyspatch/client/model/APIError.java b/src/main/java/io/dyspatch/client/model/APIError.java index 157ed2b..1d55485 100644 --- a/src/main/java/io/dyspatch/client/model/APIError.java +++ b/src/main/java/io/dyspatch/client/model/APIError.java @@ -2,7 +2,7 @@ * Dyspatch API * # 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) * - * The version of the OpenAPI document: 2020.08 + * The version of the OpenAPI document: 2020.11 * Contact: support@dyspatch.io * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/main/java/io/dyspatch/client/model/CompiledRead.java b/src/main/java/io/dyspatch/client/model/CompiledRead.java index c70038d..b080dff 100644 --- a/src/main/java/io/dyspatch/client/model/CompiledRead.java +++ b/src/main/java/io/dyspatch/client/model/CompiledRead.java @@ -2,7 +2,7 @@ * Dyspatch API * # 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) * - * The version of the OpenAPI document: 2020.08 + * The version of the OpenAPI document: 2020.11 * Contact: support@dyspatch.io * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -66,7 +66,7 @@ public CompiledRead sender(String sender) { * @return sender **/ @javax.annotation.Nullable - @ApiModelProperty(example = "Example", value = "Sender address") + @ApiModelProperty(example = "example@example.com", value = "Sender address") public String getSender() { return sender; @@ -89,7 +89,7 @@ public CompiledRead replyTo(String replyTo) { * @return replyTo **/ @javax.annotation.Nullable - @ApiModelProperty(example = "Example", value = "Reply-To address") + @ApiModelProperty(example = "example@example.com", value = "Reply-To address") public String getReplyTo() { return replyTo; @@ -154,11 +154,11 @@ public CompiledRead ampHtml(byte[] ampHtml) { } /** - * Base64 encoded amp version of template body + * Base64 encoded template AMP body * @return ampHtml **/ @javax.annotation.Nullable - @ApiModelProperty(value = "Base64 encoded amp version of template body") + @ApiModelProperty(value = "Base64 encoded template AMP body") public byte[] getAmpHtml() { return ampHtml; diff --git a/src/main/java/io/dyspatch/client/model/Cursor.java b/src/main/java/io/dyspatch/client/model/Cursor.java index d905b3b..72dced2 100644 --- a/src/main/java/io/dyspatch/client/model/Cursor.java +++ b/src/main/java/io/dyspatch/client/model/Cursor.java @@ -2,7 +2,7 @@ * Dyspatch API * # 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) * - * The version of the OpenAPI document: 2020.08 + * The version of the OpenAPI document: 2020.11 * Contact: support@dyspatch.io * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/main/java/io/dyspatch/client/model/DraftMetaRead.java b/src/main/java/io/dyspatch/client/model/DraftMetaRead.java index 9240f0d..690490e 100644 --- a/src/main/java/io/dyspatch/client/model/DraftMetaRead.java +++ b/src/main/java/io/dyspatch/client/model/DraftMetaRead.java @@ -2,7 +2,7 @@ * Dyspatch API * # 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) * - * The version of the OpenAPI document: 2020.08 + * The version of the OpenAPI document: 2020.11 * Contact: support@dyspatch.io * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/main/java/io/dyspatch/client/model/DraftRead.java b/src/main/java/io/dyspatch/client/model/DraftRead.java index a235938..20c45b8 100644 --- a/src/main/java/io/dyspatch/client/model/DraftRead.java +++ b/src/main/java/io/dyspatch/client/model/DraftRead.java @@ -2,7 +2,7 @@ * Dyspatch API * # 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) * - * The version of the OpenAPI document: 2020.08 + * The version of the OpenAPI document: 2020.11 * Contact: support@dyspatch.io * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/main/java/io/dyspatch/client/model/DraftsRead.java b/src/main/java/io/dyspatch/client/model/DraftsRead.java index 5de2526..fbbedd8 100644 --- a/src/main/java/io/dyspatch/client/model/DraftsRead.java +++ b/src/main/java/io/dyspatch/client/model/DraftsRead.java @@ -2,7 +2,7 @@ * Dyspatch API * # 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) * - * The version of the OpenAPI document: 2020.08 + * The version of the OpenAPI document: 2020.11 * Contact: support@dyspatch.io * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/main/java/io/dyspatch/client/model/InlineObject.java b/src/main/java/io/dyspatch/client/model/InlineObject.java index 826afc6..c7e60c1 100644 --- a/src/main/java/io/dyspatch/client/model/InlineObject.java +++ b/src/main/java/io/dyspatch/client/model/InlineObject.java @@ -2,7 +2,7 @@ * Dyspatch API * # 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) * - * The version of the OpenAPI document: 2020.08 + * The version of the OpenAPI document: 2020.11 * Contact: support@dyspatch.io * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/main/java/io/dyspatch/client/model/LocalizationKeyRead.java b/src/main/java/io/dyspatch/client/model/LocalizationKeyRead.java index 735a743..b03cd95 100644 --- a/src/main/java/io/dyspatch/client/model/LocalizationKeyRead.java +++ b/src/main/java/io/dyspatch/client/model/LocalizationKeyRead.java @@ -2,7 +2,7 @@ * Dyspatch API * # 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) * - * The version of the OpenAPI document: 2020.08 + * The version of the OpenAPI document: 2020.11 * Contact: support@dyspatch.io * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/main/java/io/dyspatch/client/model/LocalizationMetaRead.java b/src/main/java/io/dyspatch/client/model/LocalizationMetaRead.java index e4c9402..ef34f24 100644 --- a/src/main/java/io/dyspatch/client/model/LocalizationMetaRead.java +++ b/src/main/java/io/dyspatch/client/model/LocalizationMetaRead.java @@ -2,7 +2,7 @@ * Dyspatch API * # 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) * - * The version of the OpenAPI document: 2020.08 + * The version of the OpenAPI document: 2020.11 * Contact: support@dyspatch.io * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/main/java/io/dyspatch/client/model/LocalizationRead.java b/src/main/java/io/dyspatch/client/model/LocalizationRead.java index ca1fb9a..dc38baf 100644 --- a/src/main/java/io/dyspatch/client/model/LocalizationRead.java +++ b/src/main/java/io/dyspatch/client/model/LocalizationRead.java @@ -2,7 +2,7 @@ * Dyspatch API * # 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) * - * The version of the OpenAPI document: 2020.08 + * The version of the OpenAPI document: 2020.11 * Contact: support@dyspatch.io * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/main/java/io/dyspatch/client/model/TemplateMetaRead.java b/src/main/java/io/dyspatch/client/model/TemplateMetaRead.java index 1d4035c..b1c9101 100644 --- a/src/main/java/io/dyspatch/client/model/TemplateMetaRead.java +++ b/src/main/java/io/dyspatch/client/model/TemplateMetaRead.java @@ -2,7 +2,7 @@ * Dyspatch API * # 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) * - * The version of the OpenAPI document: 2020.08 + * The version of the OpenAPI document: 2020.11 * Contact: support@dyspatch.io * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/main/java/io/dyspatch/client/model/TemplateRead.java b/src/main/java/io/dyspatch/client/model/TemplateRead.java index e5adbbb..726a35f 100644 --- a/src/main/java/io/dyspatch/client/model/TemplateRead.java +++ b/src/main/java/io/dyspatch/client/model/TemplateRead.java @@ -2,7 +2,7 @@ * Dyspatch API * # 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) * - * The version of the OpenAPI document: 2020.08 + * The version of the OpenAPI document: 2020.11 * Contact: support@dyspatch.io * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/main/java/io/dyspatch/client/model/TemplatesRead.java b/src/main/java/io/dyspatch/client/model/TemplatesRead.java index 90ad852..a70f78f 100644 --- a/src/main/java/io/dyspatch/client/model/TemplatesRead.java +++ b/src/main/java/io/dyspatch/client/model/TemplatesRead.java @@ -2,7 +2,7 @@ * Dyspatch API * # 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) * - * The version of the OpenAPI document: 2020.08 + * The version of the OpenAPI document: 2020.11 * Contact: support@dyspatch.io * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/io/dyspatch/client/api/DraftsApiTest.java b/src/test/java/io/dyspatch/client/api/DraftsApiTest.java index a538754..1621f8e 100644 --- a/src/test/java/io/dyspatch/client/api/DraftsApiTest.java +++ b/src/test/java/io/dyspatch/client/api/DraftsApiTest.java @@ -2,7 +2,7 @@ * Dyspatch API * # 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) * - * The version of the OpenAPI document: 2020.08 + * The version of the OpenAPI document: 2020.11 * Contact: support@dyspatch.io * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -76,7 +76,7 @@ public void getDraftByIdTest() throws ApiException { /** * Get localization keys * - * Returns the list of values that need to be translated for the draft. Set the `Accept` header to `application/vnd.dyspatch.2020.08+json` to get a JSON object, or `text/vnd.dyspatch.2020.08+x-gettext-translation` to get the POT file. + * 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. * * @throws ApiException * if the Api call fails diff --git a/src/test/java/io/dyspatch/client/api/LocalizationsApiTest.java b/src/test/java/io/dyspatch/client/api/LocalizationsApiTest.java index 629cb09..b31aeaf 100644 --- a/src/test/java/io/dyspatch/client/api/LocalizationsApiTest.java +++ b/src/test/java/io/dyspatch/client/api/LocalizationsApiTest.java @@ -2,7 +2,7 @@ * Dyspatch API * # 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) * - * The version of the OpenAPI document: 2020.08 + * The version of the OpenAPI document: 2020.11 * Contact: support@dyspatch.io * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -33,20 +33,39 @@ public class LocalizationsApiTest { private final LocalizationsApi api = new LocalizationsApi(); + /** + * Get Draft Localization Object by ID + * + * Returns a specific localization object of the matching draft with a matching localization ID + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void getDraftLocalizationByIdTest() throws ApiException { + String draftId = null; + String localizationId = null; + String targetLanguage = null; + String accept = null; + LocalizationRead response = api.getDraftLocalizationById(draftId, localizationId, targetLanguage, accept); + + // TODO: test validations + } + /** * Get Localization Object by ID * - * Returns a specific localization object with a matching ID + * Returns the published content associated with the localization of the matching ID * * @throws ApiException * if the Api call fails */ @Test - public void getLocalizationByIdTest() throws ApiException { + public void getPublishedLocalizationByIdTest() throws ApiException { String localizationId = null; String targetLanguage = null; String accept = null; - LocalizationRead response = api.getLocalizationById(localizationId, targetLanguage, accept); + LocalizationRead response = api.getPublishedLocalizationById(localizationId, targetLanguage, accept); // TODO: test validations } diff --git a/src/test/java/io/dyspatch/client/api/TemplatesApiTest.java b/src/test/java/io/dyspatch/client/api/TemplatesApiTest.java index c729cf6..8bc9a08 100644 --- a/src/test/java/io/dyspatch/client/api/TemplatesApiTest.java +++ b/src/test/java/io/dyspatch/client/api/TemplatesApiTest.java @@ -2,7 +2,7 @@ * Dyspatch API * # 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) * - * The version of the OpenAPI document: 2020.08 + * The version of the OpenAPI document: 2020.11 * Contact: support@dyspatch.io * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).