diff --git a/docs/CompiledRead.md b/docs/CompiledRead.md index 2a05e6d..e5cc1d3 100644 --- a/docs/CompiledRead.md +++ b/docs/CompiledRead.md @@ -8,6 +8,7 @@ Name | Type | Description | Notes **replyTo** | **String** | Reply-To address | [optional] **subject** | **Blob** | Base64 encoded template subject line | [optional] **html** | **Blob** | Base64 encoded template HTML body | [optional] +**ampHtml** | **Blob** | Base64 encoded template AMP body | [optional] **text** | **Blob** | Base64 encoded template text body | [optional] diff --git a/docs/DraftsApi.md b/docs/DraftsApi.md index 5f4342d..7b9b573 100644 --- a/docs/DraftsApi.md +++ b/docs/DraftsApi.md @@ -37,7 +37,7 @@ Bearer.apiKey = 'YOUR API KEY'; let apiInstance = new DyspatchClient.DraftsApi(); let draftId = "draftId_example"; // String | A draft ID let languageId = "languageId_example"; // String | A language ID (eg: en-US) -let accept = "accept_example"; // String | A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\" +let 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\" apiInstance.deleteLocalization(draftId, languageId, accept).then(() => { console.log('API called successfully.'); }, (error) => { @@ -53,7 +53,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.04\", set the value to \"application/vnd.dyspatch.2020.04+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 @@ -91,7 +91,7 @@ Bearer.apiKey = 'YOUR API KEY'; let apiInstance = new DyspatchClient.DraftsApi(); let draftId = "draftId_example"; // String | A draft ID let targetLanguage = "targetLanguage_example"; // String | The type of templating language to compile as. Should only be used for visual templates. -let accept = "accept_example"; // String | A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\" +let 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\" apiInstance.getDraftById(draftId, targetLanguage, accept).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { @@ -107,7 +107,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. | - **accept** | **String**| A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\" | + **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 @@ -120,7 +120,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined -- **Accept**: application/vnd.dyspatch.2020.04+json, */* +- **Accept**: application/vnd.dyspatch.2020.11+json, */* ## getDraftLocalizationKeys @@ -129,7 +129,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.04+json` to get a JSON object, or `text/vnd.dyspatch.2020.04+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 @@ -144,7 +144,7 @@ Bearer.apiKey = 'YOUR API KEY'; let apiInstance = new DyspatchClient.DraftsApi(); let draftId = "draftId_example"; // String | A draft ID -let accept = "accept_example"; // String | A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\" +let 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\" apiInstance.getDraftLocalizationKeys(draftId, accept).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { @@ -159,7 +159,7 @@ apiInstance.getDraftLocalizationKeys(draftId, accept).then((data) => { 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.04\", set the value to \"application/vnd.dyspatch.2020.04+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 @@ -172,7 +172,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined -- **Accept**: application/vnd.dyspatch.2020.04+json, text/vnd.dyspatch.2020.04+x-gettext-translation +- **Accept**: application/vnd.dyspatch.2020.11+json, text/vnd.dyspatch.2020.11+x-gettext-translation ## getDrafts @@ -195,7 +195,7 @@ Bearer.apiKey = 'YOUR API KEY'; //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new DyspatchClient.DraftsApi(); -let accept = "accept_example"; // String | A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\" +let 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\" let opts = { 'cursor': "cursor_example", // String | A cursor value used to retrieve a specific page from a paginated result set. 'status': "status_example" // String | Filter the list of drafts by a particular status @@ -213,7 +213,7 @@ apiInstance.getDrafts(accept, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **accept** | **String**| A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\" | + **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] @@ -228,7 +228,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined -- **Accept**: application/vnd.dyspatch.2020.04+json, */* +- **Accept**: application/vnd.dyspatch.2020.11+json, */* ## getLocalizationForDraft @@ -252,7 +252,7 @@ Bearer.apiKey = 'YOUR API KEY'; let apiInstance = new DyspatchClient.DraftsApi(); let draftId = "draftId_example"; // String | A draft ID -let accept = "accept_example"; // String | A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\" +let 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\" apiInstance.getLocalizationForDraft(draftId, accept).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { @@ -267,7 +267,7 @@ apiInstance.getLocalizationForDraft(draftId, accept).then((data) => { 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.04\", set the value to \"application/vnd.dyspatch.2020.04+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 @@ -280,7 +280,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined -- **Accept**: application/vnd.dyspatch.2020.04+json +- **Accept**: application/vnd.dyspatch.2020.11+json ## saveLocalization @@ -305,7 +305,7 @@ Bearer.apiKey = 'YOUR API KEY'; let apiInstance = new DyspatchClient.DraftsApi(); let draftId = "draftId_example"; // String | A draft ID let languageId = "languageId_example"; // String | A language ID (eg: en-US) -let accept = "accept_example"; // String | A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\" +let 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\" let inlineObject = new DyspatchClient.InlineObject(); // InlineObject | apiInstance.saveLocalization(draftId, languageId, accept, inlineObject).then(() => { console.log('API called successfully.'); @@ -322,7 +322,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.04\", set the value to \"application/vnd.dyspatch.2020.04+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 @@ -361,7 +361,7 @@ Bearer.apiKey = 'YOUR API KEY'; let apiInstance = new DyspatchClient.DraftsApi(); let draftId = "draftId_example"; // String | A draft ID let languageId = "languageId_example"; // String | A language ID (eg: en-US) -let accept = "accept_example"; // String | A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\" +let 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\" let requestBody = {key: "null"}; // {String: String} | apiInstance.setTranslation(draftId, languageId, accept, requestBody).then(() => { console.log('API called successfully.'); @@ -378,7 +378,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.04\", set the value to \"application/vnd.dyspatch.2020.04+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** | [**{String: String}**](String.md)| | ### Return type @@ -416,7 +416,7 @@ Bearer.apiKey = 'YOUR API KEY'; let apiInstance = new DyspatchClient.DraftsApi(); let draftId = "draftId_example"; // String | A draft ID -let accept = "accept_example"; // String | A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\" +let 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\" apiInstance.submitDraftForApproval(draftId, accept).then(() => { console.log('API called successfully.'); }, (error) => { @@ -431,7 +431,7 @@ apiInstance.submitDraftForApproval(draftId, accept).then(() => { 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.04\", set the value to \"application/vnd.dyspatch.2020.04+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 d8cc7dd..2862c46 100644 --- a/docs/LocalizationsApi.md +++ b/docs/LocalizationsApi.md @@ -4,17 +4,74 @@ 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 +## getDraftLocalizationById -> LocalizationRead getLocalizationById(localizationId, targetLanguage, accept) +> 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 + +```javascript +import DyspatchClient from 'dyspatch-client'; +let defaultClient = DyspatchClient.ApiClient.instance; +// Configure API key authorization: Bearer +let Bearer = defaultClient.authentications['Bearer']; +Bearer.apiKey = 'YOUR API KEY'; +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) +//Bearer.apiKeyPrefix = 'Token'; + +let apiInstance = new DyspatchClient.LocalizationsApi(); +let draftId = "draftId_example"; // String | A draft ID +let localizationId = "localizationId_example"; // String | A localization ID +let targetLanguage = "targetLanguage_example"; // String | The type of templating language to compile as. Should only be used for visual templates. +let 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\" +apiInstance.getDraftLocalizationById(draftId, localizationId, targetLanguage, accept).then((data) => { + console.log('API called successfully. Returned data: ' + data); +}, (error) => { + console.error(error); +}); + +``` + +### 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. | + **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, */* + + +## 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 @@ -30,8 +87,8 @@ Bearer.apiKey = 'YOUR API KEY'; let apiInstance = new DyspatchClient.LocalizationsApi(); let localizationId = "localizationId_example"; // String | A localization ID let targetLanguage = "targetLanguage_example"; // String | The type of templating language to compile as. Should only be used for visual templates. -let accept = "accept_example"; // String | A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\" -apiInstance.getLocalizationById(localizationId, targetLanguage, accept).then((data) => { +let 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\" +apiInstance.getPublishedLocalizationById(localizationId, targetLanguage, accept).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); @@ -46,7 +103,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. | - **accept** | **String**| A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\" | + **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 @@ -59,5 +116,5 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined -- **Accept**: application/vnd.dyspatch.2020.04+json, */* +- **Accept**: application/vnd.dyspatch.2020.11+json, */* diff --git a/docs/TemplatesApi.md b/docs/TemplatesApi.md index a1d3767..f2d1271 100644 --- a/docs/TemplatesApi.md +++ b/docs/TemplatesApi.md @@ -31,7 +31,7 @@ Bearer.apiKey = 'YOUR API KEY'; let apiInstance = new DyspatchClient.TemplatesApi(); let templateId = "templateId_example"; // String | A template ID let targetLanguage = "targetLanguage_example"; // String | The type of templating language to compile as. Should only be used for visual templates. -let accept = "accept_example"; // String | A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\" +let 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\" apiInstance.getTemplateById(templateId, targetLanguage, accept).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { @@ -47,7 +47,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. | - **accept** | **String**| A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\" | + **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 @@ -60,7 +60,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined -- **Accept**: application/vnd.dyspatch.2020.04+json, */* +- **Accept**: application/vnd.dyspatch.2020.11+json, */* ## getTemplates @@ -83,7 +83,7 @@ Bearer.apiKey = 'YOUR API KEY'; //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new DyspatchClient.TemplatesApi(); -let accept = "accept_example"; // String | A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\" +let 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\" let opts = { 'cursor': "cursor_example" // String | A cursor value used to retrieve a specific page from a paginated result set. }; @@ -100,7 +100,7 @@ apiInstance.getTemplates(accept, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **accept** | **String**| A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\" | + **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 @@ -114,5 +114,5 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined -- **Accept**: application/vnd.dyspatch.2020.04+json, */* +- **Accept**: application/vnd.dyspatch.2020.11+json, */* diff --git a/package.json b/package.json index a69a110..ea4e6f1 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "dyspatch-client", - "version": "5.0.1", + "version": "6.0.0", "description": "_IntroductionThe_Dyspatch_API_is_based_on_the_REST_paradigm_and_features_resource_based_URLs_with_standard_HTTP_responsecodes_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_onhow_to_implement_Dyspatch__API_Client_LibrariesDyspatch_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", "license": "Apache-2.0", "main": "dist/index.js", diff --git a/src/ApiClient.js b/src/ApiClient.js index 06415a2..427dda3 100644 --- a/src/ApiClient.js +++ b/src/ApiClient.js @@ -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.04 + * 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). @@ -17,7 +17,7 @@ import querystring from "querystring"; /** * @module ApiClient -* @version 5.0.1 +* @version 6.0.0 */ /** diff --git a/src/dyspatch-client/APIError.js b/src/dyspatch-client/APIError.js index 566e767..3537361 100644 --- a/src/dyspatch-client/APIError.js +++ b/src/dyspatch-client/APIError.js @@ -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.04 + * 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). @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The APIError model module. * @module dyspatch-client/APIError - * @version 5.0.1 + * @version 6.0.0 */ class APIError { /** diff --git a/src/dyspatch-client/CompiledRead.js b/src/dyspatch-client/CompiledRead.js index 8f0def7..c3be1b9 100644 --- a/src/dyspatch-client/CompiledRead.js +++ b/src/dyspatch-client/CompiledRead.js @@ -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.04 + * 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). @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CompiledRead model module. * @module dyspatch-client/CompiledRead - * @version 5.0.1 + * @version 6.0.0 */ class CompiledRead { /** @@ -60,6 +60,9 @@ class CompiledRead { if (data.hasOwnProperty('html')) { obj['html'] = ApiClient.convertToType(data['html'], 'Blob'); } + if (data.hasOwnProperty('ampHtml')) { + obj['ampHtml'] = ApiClient.convertToType(data['ampHtml'], 'Blob'); + } if (data.hasOwnProperty('text')) { obj['text'] = ApiClient.convertToType(data['text'], 'Blob'); } @@ -94,6 +97,12 @@ CompiledRead.prototype['subject'] = undefined; */ CompiledRead.prototype['html'] = undefined; +/** + * Base64 encoded template AMP body + * @member {Blob} ampHtml + */ +CompiledRead.prototype['ampHtml'] = undefined; + /** * Base64 encoded template text body * @member {Blob} text diff --git a/src/dyspatch-client/Cursor.js b/src/dyspatch-client/Cursor.js index 825e383..115eb9e 100644 --- a/src/dyspatch-client/Cursor.js +++ b/src/dyspatch-client/Cursor.js @@ -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.04 + * 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). @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The Cursor model module. * @module dyspatch-client/Cursor - * @version 5.0.1 + * @version 6.0.0 */ class Cursor { /** diff --git a/src/dyspatch-client/DraftMetaRead.js b/src/dyspatch-client/DraftMetaRead.js index 168e77c..75b2e54 100644 --- a/src/dyspatch-client/DraftMetaRead.js +++ b/src/dyspatch-client/DraftMetaRead.js @@ -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.04 + * 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). @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The DraftMetaRead model module. * @module dyspatch-client/DraftMetaRead - * @version 5.0.1 + * @version 6.0.0 */ class DraftMetaRead { /** diff --git a/src/dyspatch-client/DraftRead.js b/src/dyspatch-client/DraftRead.js index 3bfd30a..96e30c4 100644 --- a/src/dyspatch-client/DraftRead.js +++ b/src/dyspatch-client/DraftRead.js @@ -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.04 + * 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). @@ -18,7 +18,7 @@ import LocalizationMetaRead from './LocalizationMetaRead'; /** * The DraftRead model module. * @module dyspatch-client/DraftRead - * @version 5.0.1 + * @version 6.0.0 */ class DraftRead { /** diff --git a/src/dyspatch-client/DraftsApi.js b/src/dyspatch-client/DraftsApi.js index 96b0f51..70eaf20 100644 --- a/src/dyspatch-client/DraftsApi.js +++ b/src/dyspatch-client/DraftsApi.js @@ -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.04 + * 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). @@ -23,7 +23,7 @@ import LocalizationMetaRead from '../dyspatch-client/LocalizationMetaRead'; /** * Drafts service. * @module dyspatch-client/DraftsApi -* @version 5.0.1 +* @version 6.0.0 */ export default class DraftsApi { @@ -45,7 +45,7 @@ dfkajsldfjasldkjfaslkdjflaskjdflksajdlfkjs * Deletes the localization with the given language ID if it exists * @param {String} draftId A draft ID * @param {String} languageId A language ID (eg: en-US) - * @param {String} accept A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\" + * @param {String} 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\" * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response */ deleteLocalizationWithHttpInfo(draftId, languageId, accept) { @@ -77,7 +77,7 @@ dfkajsldfjasldkjfaslkdjflaskjdflksajdlfkjs let authNames = ['Bearer']; let contentTypes = []; - let accepts = ['application/vnd.dyspatch.2020.04+json', '*/*']; + let accepts = ['application/vnd.dyspatch.2020.11+json', '*/*']; let returnType = null; return this.apiClient.callApi( '/drafts/{draftId}/localizations/{languageId}', 'DELETE', @@ -91,7 +91,7 @@ dfkajsldfjasldkjfaslkdjflaskjdflksajdlfkjs * Deletes the localization with the given language ID if it exists * @param {String} draftId A draft ID * @param {String} languageId A language ID (eg: en-US) - * @param {String} accept A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\" + * @param {String} 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\" * @return {Promise} a {@link https://www.promisejs.org/|Promise} */ deleteLocalization(draftId, languageId, accept) { @@ -107,7 +107,7 @@ dfkajsldfjasldkjfaslkdjflaskjdflksajdlfkjs * Gets a draft object with the matching ID. The \"compiled\" field will contain the template in the default, unlocalized form. * @param {String} draftId A draft ID * @param {module:dyspatch-client/String} targetLanguage The type of templating language to compile as. Should only be used for visual templates. - * @param {String} accept A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\" + * @param {String} 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\" * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:dyspatch-client/DraftRead} and HTTP response */ getDraftByIdWithHttpInfo(draftId, targetLanguage, accept) { @@ -139,7 +139,7 @@ dfkajsldfjasldkjfaslkdjflaskjdflksajdlfkjs let authNames = ['Bearer']; let contentTypes = []; - let accepts = ['application/vnd.dyspatch.2020.04+json', '*/*']; + let accepts = ['application/vnd.dyspatch.2020.11+json', '*/*']; let returnType = DraftRead; return this.apiClient.callApi( '/drafts/{draftId}', 'GET', @@ -153,7 +153,7 @@ dfkajsldfjasldkjfaslkdjflaskjdflksajdlfkjs * Gets a draft object with the matching ID. The \"compiled\" field will contain the template in the default, unlocalized form. * @param {String} draftId A draft ID * @param {module:dyspatch-client/String} targetLanguage The type of templating language to compile as. Should only be used for visual templates. - * @param {String} accept A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\" + * @param {String} 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\" * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:dyspatch-client/DraftRead} */ getDraftById(draftId, targetLanguage, accept) { @@ -166,9 +166,9 @@ dfkajsldfjasldkjfaslkdjflaskjdflksajdlfkjs /** * 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.04+json` to get a JSON object, or `text/vnd.dyspatch.2020.04+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 {String} draftId A draft ID - * @param {String} accept A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\" + * @param {String} 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\" * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response */ getDraftLocalizationKeysWithHttpInfo(draftId, accept) { @@ -195,7 +195,7 @@ dfkajsldfjasldkjfaslkdjflaskjdflksajdlfkjs let authNames = ['Bearer']; let contentTypes = []; - let accepts = ['application/vnd.dyspatch.2020.04+json', '*/*']; + let accepts = ['application/vnd.dyspatch.2020.11+json', '*/*']; let returnType = [LocalizationKeyRead]; return this.apiClient.callApi( '/drafts/{draftId}/localizationKeys', 'GET', @@ -206,9 +206,9 @@ dfkajsldfjasldkjfaslkdjflaskjdflksajdlfkjs /** * 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.04+json` to get a JSON object, or `text/vnd.dyspatch.2020.04+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 {String} draftId A draft ID - * @param {String} accept A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\" + * @param {String} 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\" * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} */ getDraftLocalizationKeys(draftId, accept) { @@ -222,7 +222,7 @@ dfkajsldfjasldkjfaslkdjflaskjdflksajdlfkjs /** * List Drafts * Returns all drafts for your organization. - * @param {String} accept A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\" + * @param {String} 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\" * @param {Object} opts Optional parameters * @param {String} opts.cursor A cursor value used to retrieve a specific page from a paginated result set. * @param {module:dyspatch-client/String} opts.status Filter the list of drafts by a particular status @@ -250,7 +250,7 @@ dfkajsldfjasldkjfaslkdjflaskjdflksajdlfkjs let authNames = ['Bearer']; let contentTypes = []; - let accepts = ['application/vnd.dyspatch.2020.04+json', '*/*']; + let accepts = ['application/vnd.dyspatch.2020.11+json', '*/*']; let returnType = DraftsRead; return this.apiClient.callApi( '/drafts', 'GET', @@ -262,7 +262,7 @@ dfkajsldfjasldkjfaslkdjflaskjdflksajdlfkjs /** * List Drafts * Returns all drafts for your organization. - * @param {String} accept A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\" + * @param {String} 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\" * @param {Object} opts Optional parameters * @param {String} opts.cursor A cursor value used to retrieve a specific page from a paginated result set. * @param {module:dyspatch-client/String} opts.status Filter the list of drafts by a particular status @@ -280,7 +280,7 @@ dfkajsldfjasldkjfaslkdjflaskjdflksajdlfkjs * Get localizations on a draft * Returns localization metadata for the draft * @param {String} draftId A draft ID - * @param {String} accept A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\" + * @param {String} 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\" * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response */ getLocalizationForDraftWithHttpInfo(draftId, accept) { @@ -307,7 +307,7 @@ dfkajsldfjasldkjfaslkdjflaskjdflksajdlfkjs let authNames = ['Bearer']; let contentTypes = []; - let accepts = ['application/vnd.dyspatch.2020.04+json', '*/*']; + let accepts = ['application/vnd.dyspatch.2020.11+json', '*/*']; let returnType = [LocalizationMetaRead]; return this.apiClient.callApi( '/drafts/{draftId}/localizations', 'GET', @@ -320,7 +320,7 @@ dfkajsldfjasldkjfaslkdjflaskjdflksajdlfkjs * Get localizations on a draft * Returns localization metadata for the draft * @param {String} draftId A draft ID - * @param {String} accept A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\" + * @param {String} 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\" * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} */ getLocalizationForDraft(draftId, accept) { @@ -336,7 +336,7 @@ dfkajsldfjasldkjfaslkdjflaskjdflksajdlfkjs * Inserts a localization or sets the name on an existing localization that already uses the languageId * @param {String} draftId A draft ID * @param {String} languageId A language ID (eg: en-US) - * @param {String} accept A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\" + * @param {String} 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\" * @param {module:dyspatch-client/InlineObject} inlineObject * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response */ @@ -373,7 +373,7 @@ dfkajsldfjasldkjfaslkdjflaskjdflksajdlfkjs let authNames = ['Bearer']; let contentTypes = ['application/json']; - let accepts = ['application/vnd.dyspatch.2020.04+json', '*/*']; + let accepts = ['application/vnd.dyspatch.2020.11+json', '*/*']; let returnType = null; return this.apiClient.callApi( '/drafts/{draftId}/localizations/{languageId}', 'PUT', @@ -387,7 +387,7 @@ dfkajsldfjasldkjfaslkdjflaskjdflksajdlfkjs * Inserts a localization or sets the name on an existing localization that already uses the languageId * @param {String} draftId A draft ID * @param {String} languageId A language ID (eg: en-US) - * @param {String} accept A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\" + * @param {String} 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\" * @param {module:dyspatch-client/InlineObject} inlineObject * @return {Promise} a {@link https://www.promisejs.org/|Promise} */ @@ -404,7 +404,7 @@ dfkajsldfjasldkjfaslkdjflaskjdflksajdlfkjs * 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 {String} draftId A draft ID * @param {String} languageId A language ID (eg: en-US) - * @param {String} accept A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\" + * @param {String} 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\" * @param {Object.} requestBody * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response */ @@ -441,7 +441,7 @@ dfkajsldfjasldkjfaslkdjflaskjdflksajdlfkjs let authNames = ['Bearer']; let contentTypes = ['application/json']; - let accepts = ['application/vnd.dyspatch.2020.04+json', '*/*']; + let accepts = ['application/vnd.dyspatch.2020.11+json', '*/*']; let returnType = null; return this.apiClient.callApi( '/drafts/{draftId}/localizations/{languageId}/translations', 'PUT', @@ -455,7 +455,7 @@ dfkajsldfjasldkjfaslkdjflaskjdflksajdlfkjs * 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 {String} draftId A draft ID * @param {String} languageId A language ID (eg: en-US) - * @param {String} accept A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\" + * @param {String} 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\" * @param {Object.} requestBody * @return {Promise} a {@link https://www.promisejs.org/|Promise} */ @@ -471,7 +471,7 @@ dfkajsldfjasldkjfaslkdjflaskjdflksajdlfkjs * Submit the draft for approval * Moves the draft into submitted state. * @param {String} draftId A draft ID - * @param {String} accept A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\" + * @param {String} 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\" * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response */ submitDraftForApprovalWithHttpInfo(draftId, accept) { @@ -498,7 +498,7 @@ dfkajsldfjasldkjfaslkdjflaskjdflksajdlfkjs let authNames = ['Bearer']; let contentTypes = []; - let accepts = ['application/vnd.dyspatch.2020.04+json', '*/*']; + let accepts = ['application/vnd.dyspatch.2020.11+json', '*/*']; let returnType = null; return this.apiClient.callApi( '/drafts/{draftId}/publishRequest', 'POST', @@ -511,7 +511,7 @@ dfkajsldfjasldkjfaslkdjflaskjdflksajdlfkjs * Submit the draft for approval * Moves the draft into submitted state. * @param {String} draftId A draft ID - * @param {String} accept A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\" + * @param {String} 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\" * @return {Promise} a {@link https://www.promisejs.org/|Promise} */ submitDraftForApproval(draftId, accept) { diff --git a/src/dyspatch-client/DraftsRead.js b/src/dyspatch-client/DraftsRead.js index b379d83..af2435e 100644 --- a/src/dyspatch-client/DraftsRead.js +++ b/src/dyspatch-client/DraftsRead.js @@ -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.04 + * 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). @@ -18,7 +18,7 @@ import DraftMetaRead from './DraftMetaRead'; /** * The DraftsRead model module. * @module dyspatch-client/DraftsRead - * @version 5.0.1 + * @version 6.0.0 */ class DraftsRead { /** diff --git a/src/dyspatch-client/InlineObject.js b/src/dyspatch-client/InlineObject.js index 07fd639..c9f5ec5 100644 --- a/src/dyspatch-client/InlineObject.js +++ b/src/dyspatch-client/InlineObject.js @@ -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.04 + * 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). @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The InlineObject model module. * @module dyspatch-client/InlineObject - * @version 5.0.1 + * @version 6.0.0 */ class InlineObject { /** diff --git a/src/dyspatch-client/LocalizationKeyRead.js b/src/dyspatch-client/LocalizationKeyRead.js index f38dc92..1d5bd6d 100644 --- a/src/dyspatch-client/LocalizationKeyRead.js +++ b/src/dyspatch-client/LocalizationKeyRead.js @@ -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.04 + * 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). @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The LocalizationKeyRead model module. * @module dyspatch-client/LocalizationKeyRead - * @version 5.0.1 + * @version 6.0.0 */ class LocalizationKeyRead { /** diff --git a/src/dyspatch-client/LocalizationMetaRead.js b/src/dyspatch-client/LocalizationMetaRead.js index cdedfa0..0b05380 100644 --- a/src/dyspatch-client/LocalizationMetaRead.js +++ b/src/dyspatch-client/LocalizationMetaRead.js @@ -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.04 + * 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). @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The LocalizationMetaRead model module. * @module dyspatch-client/LocalizationMetaRead - * @version 5.0.1 + * @version 6.0.0 */ class LocalizationMetaRead { /** diff --git a/src/dyspatch-client/LocalizationRead.js b/src/dyspatch-client/LocalizationRead.js index 59acdb1..11e6b70 100644 --- a/src/dyspatch-client/LocalizationRead.js +++ b/src/dyspatch-client/LocalizationRead.js @@ -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.04 + * 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). @@ -17,7 +17,7 @@ import CompiledRead from './CompiledRead'; /** * The LocalizationRead model module. * @module dyspatch-client/LocalizationRead - * @version 5.0.1 + * @version 6.0.0 */ class LocalizationRead { /** diff --git a/src/dyspatch-client/LocalizationsApi.js b/src/dyspatch-client/LocalizationsApi.js index f77eb14..a522b7a 100644 --- a/src/dyspatch-client/LocalizationsApi.js +++ b/src/dyspatch-client/LocalizationsApi.js @@ -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.04 + * 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). @@ -19,7 +19,7 @@ import LocalizationRead from '../dyspatch-client/LocalizationRead'; /** * Localizations service. * @module dyspatch-client/LocalizationsApi -* @version 5.0.1 +* @version 6.0.0 */ export default class LocalizationsApi { @@ -36,27 +36,96 @@ export default class LocalizationsApi { dfkajsldfjasldkjfaslkdjflaskjdflksajdlfkjs + /** + * Get Draft Localization Object by ID + * Returns a specific localization object of the matching draft with a matching localization ID + * @param {String} draftId A draft ID + * @param {String} localizationId A localization ID + * @param {module:dyspatch-client/String} targetLanguage The type of templating language to compile as. Should only be used for visual templates. + * @param {String} 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\" + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:dyspatch-client/LocalizationRead} and HTTP response + */ + getDraftLocalizationByIdWithHttpInfo(draftId, localizationId, targetLanguage, accept) { + let postBody = null; + // verify the required parameter 'draftId' is set + if (draftId === undefined || draftId === null) { + throw new Error("Missing the required parameter 'draftId' when calling getDraftLocalizationById"); + } + // verify the required parameter 'localizationId' is set + if (localizationId === undefined || localizationId === null) { + throw new Error("Missing the required parameter 'localizationId' when calling getDraftLocalizationById"); + } + // verify the required parameter 'targetLanguage' is set + if (targetLanguage === undefined || targetLanguage === null) { + throw new Error("Missing the required parameter 'targetLanguage' when calling getDraftLocalizationById"); + } + // verify the required parameter 'accept' is set + if (accept === undefined || accept === null) { + throw new Error("Missing the required parameter 'accept' when calling getDraftLocalizationById"); + } + + let pathParams = { + 'draftId': draftId, + 'localizationId': localizationId + }; + let queryParams = { + 'targetLanguage': targetLanguage + }; + let headerParams = { + 'Accept': accept + }; + let formParams = { + }; + + let authNames = ['Bearer']; + let contentTypes = []; + let accepts = ['application/vnd.dyspatch.2020.11+json', '*/*']; + let returnType = LocalizationRead; + return this.apiClient.callApi( + '/localizations/{localizationId}/drafts/{draftId}', 'GET', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType, null + ); + } + + /** + * Get Draft Localization Object by ID + * Returns a specific localization object of the matching draft with a matching localization ID + * @param {String} draftId A draft ID + * @param {String} localizationId A localization ID + * @param {module:dyspatch-client/String} targetLanguage The type of templating language to compile as. Should only be used for visual templates. + * @param {String} 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\" + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:dyspatch-client/LocalizationRead} + */ + getDraftLocalizationById(draftId, localizationId, targetLanguage, accept) { + return this.getDraftLocalizationByIdWithHttpInfo(draftId, localizationId, targetLanguage, accept) + .then(function(response_and_data) { + return response_and_data.data; + }); + } + + /** * 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 {String} localizationId A localization ID * @param {module:dyspatch-client/String} targetLanguage The type of templating language to compile as. Should only be used for visual templates. - * @param {String} accept A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\" + * @param {String} 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\" * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:dyspatch-client/LocalizationRead} and HTTP response */ - getLocalizationByIdWithHttpInfo(localizationId, targetLanguage, accept) { + getPublishedLocalizationByIdWithHttpInfo(localizationId, targetLanguage, accept) { let postBody = null; // verify the required parameter 'localizationId' is set if (localizationId === undefined || localizationId === null) { - throw new Error("Missing the required parameter 'localizationId' when calling getLocalizationById"); + throw new Error("Missing the required parameter 'localizationId' when calling getPublishedLocalizationById"); } // verify the required parameter 'targetLanguage' is set if (targetLanguage === undefined || targetLanguage === null) { - throw new Error("Missing the required parameter 'targetLanguage' when calling getLocalizationById"); + throw new Error("Missing the required parameter 'targetLanguage' when calling getPublishedLocalizationById"); } // verify the required parameter 'accept' is set if (accept === undefined || accept === null) { - throw new Error("Missing the required parameter 'accept' when calling getLocalizationById"); + throw new Error("Missing the required parameter 'accept' when calling getPublishedLocalizationById"); } let pathParams = { @@ -73,7 +142,7 @@ dfkajsldfjasldkjfaslkdjflaskjdflksajdlfkjs let authNames = ['Bearer']; let contentTypes = []; - let accepts = ['application/vnd.dyspatch.2020.04+json', '*/*']; + let accepts = ['application/vnd.dyspatch.2020.11+json', '*/*']; let returnType = LocalizationRead; return this.apiClient.callApi( '/localizations/{localizationId}', 'GET', @@ -84,14 +153,14 @@ dfkajsldfjasldkjfaslkdjflaskjdflksajdlfkjs /** * 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 {String} localizationId A localization ID * @param {module:dyspatch-client/String} targetLanguage The type of templating language to compile as. Should only be used for visual templates. - * @param {String} accept A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\" + * @param {String} 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\" * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:dyspatch-client/LocalizationRead} */ - getLocalizationById(localizationId, targetLanguage, accept) { - return this.getLocalizationByIdWithHttpInfo(localizationId, targetLanguage, accept) + getPublishedLocalizationById(localizationId, targetLanguage, accept) { + return this.getPublishedLocalizationByIdWithHttpInfo(localizationId, targetLanguage, accept) .then(function(response_and_data) { return response_and_data.data; }); diff --git a/src/dyspatch-client/TemplateMetaRead.js b/src/dyspatch-client/TemplateMetaRead.js index 6550207..25c14bf 100644 --- a/src/dyspatch-client/TemplateMetaRead.js +++ b/src/dyspatch-client/TemplateMetaRead.js @@ -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.04 + * 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). @@ -17,7 +17,7 @@ import LocalizationMetaRead from './LocalizationMetaRead'; /** * The TemplateMetaRead model module. * @module dyspatch-client/TemplateMetaRead - * @version 5.0.1 + * @version 6.0.0 */ class TemplateMetaRead { /** diff --git a/src/dyspatch-client/TemplateRead.js b/src/dyspatch-client/TemplateRead.js index 4a8a8de..08e1b09 100644 --- a/src/dyspatch-client/TemplateRead.js +++ b/src/dyspatch-client/TemplateRead.js @@ -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.04 + * 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). @@ -18,7 +18,7 @@ import LocalizationMetaRead from './LocalizationMetaRead'; /** * The TemplateRead model module. * @module dyspatch-client/TemplateRead - * @version 5.0.1 + * @version 6.0.0 */ class TemplateRead { /** diff --git a/src/dyspatch-client/TemplatesApi.js b/src/dyspatch-client/TemplatesApi.js index 7eaeff6..553e9ff 100644 --- a/src/dyspatch-client/TemplatesApi.js +++ b/src/dyspatch-client/TemplatesApi.js @@ -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.04 + * 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). @@ -20,7 +20,7 @@ import TemplatesRead from '../dyspatch-client/TemplatesRead'; /** * Templates service. * @module dyspatch-client/TemplatesApi -* @version 5.0.1 +* @version 6.0.0 */ export default class TemplatesApi { @@ -42,7 +42,7 @@ dfkajsldfjasldkjfaslkdjflaskjdflksajdlfkjs * Gets a template object with the matching ID. If the template has published content the \"compiled\" field will contain the template . * @param {String} templateId A template ID * @param {module:dyspatch-client/String} targetLanguage The type of templating language to compile as. Should only be used for visual templates. - * @param {String} accept A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\" + * @param {String} 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\" * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:dyspatch-client/TemplateRead} and HTTP response */ getTemplateByIdWithHttpInfo(templateId, targetLanguage, accept) { @@ -74,7 +74,7 @@ dfkajsldfjasldkjfaslkdjflaskjdflksajdlfkjs let authNames = ['Bearer']; let contentTypes = []; - let accepts = ['application/vnd.dyspatch.2020.04+json', '*/*']; + let accepts = ['application/vnd.dyspatch.2020.11+json', '*/*']; let returnType = TemplateRead; return this.apiClient.callApi( '/templates/{templateId}', 'GET', @@ -88,7 +88,7 @@ dfkajsldfjasldkjfaslkdjflaskjdflksajdlfkjs * Gets a template object with the matching ID. If the template has published content the \"compiled\" field will contain the template . * @param {String} templateId A template ID * @param {module:dyspatch-client/String} targetLanguage The type of templating language to compile as. Should only be used for visual templates. - * @param {String} accept A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\" + * @param {String} 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\" * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:dyspatch-client/TemplateRead} */ getTemplateById(templateId, targetLanguage, accept) { @@ -102,7 +102,7 @@ dfkajsldfjasldkjfaslkdjflaskjdflksajdlfkjs /** * List Templates * Gets a list of Template Metadata objects for all templates. Up to 25 results returned before results are paginated. - * @param {String} accept A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\" + * @param {String} 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\" * @param {Object} opts Optional parameters * @param {String} opts.cursor A cursor value used to retrieve a specific page from a paginated result set. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:dyspatch-client/TemplatesRead} and HTTP response @@ -128,7 +128,7 @@ dfkajsldfjasldkjfaslkdjflaskjdflksajdlfkjs let authNames = ['Bearer']; let contentTypes = []; - let accepts = ['application/vnd.dyspatch.2020.04+json', '*/*']; + let accepts = ['application/vnd.dyspatch.2020.11+json', '*/*']; let returnType = TemplatesRead; return this.apiClient.callApi( '/templates', 'GET', @@ -140,7 +140,7 @@ dfkajsldfjasldkjfaslkdjflaskjdflksajdlfkjs /** * List Templates * Gets a list of Template Metadata objects for all templates. Up to 25 results returned before results are paginated. - * @param {String} accept A version of the API that should be used for the request. For example, to use version \"2020.04\", set the value to \"application/vnd.dyspatch.2020.04+json\" + * @param {String} 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\" * @param {Object} opts Optional parameters * @param {String} opts.cursor A cursor value used to retrieve a specific page from a paginated result set. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:dyspatch-client/TemplatesRead} diff --git a/src/dyspatch-client/TemplatesRead.js b/src/dyspatch-client/TemplatesRead.js index 380fc40..881735d 100644 --- a/src/dyspatch-client/TemplatesRead.js +++ b/src/dyspatch-client/TemplatesRead.js @@ -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.04 + * 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). @@ -18,7 +18,7 @@ import TemplateMetaRead from './TemplateMetaRead'; /** * The TemplatesRead model module. * @module dyspatch-client/TemplatesRead - * @version 5.0.1 + * @version 6.0.0 */ class TemplatesRead { /** diff --git a/src/index.js b/src/index.js index 0a13491..dd7ffd5 100644 --- a/src/index.js +++ b/src/index.js @@ -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.04 + * 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 @@ import TemplatesApi from './dyspatch-client/TemplatesApi'; * *

* @module index -* @version 5.0.1 +* @version 6.0.0 */ export { /** diff --git a/test/api/DraftsApi.spec.js b/test/api/DraftsApi.spec.js index 6d98318..305378c 100644 --- a/test/api/DraftsApi.spec.js +++ b/test/api/DraftsApi.spec.js @@ -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.04 + * 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/test/api/LocalizationsApi.spec.js b/test/api/LocalizationsApi.spec.js index 2b55c7b..0245298 100644 --- a/test/api/LocalizationsApi.spec.js +++ b/test/api/LocalizationsApi.spec.js @@ -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.04 + * 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). @@ -48,10 +48,20 @@ } describe('LocalizationsApi', function() { - describe('getLocalizationById', function() { - it('should call getLocalizationById successfully', function(done) { - //uncomment below and update the code to test getLocalizationById - //instance.getLocalizationById(function(error) { + describe('getDraftLocalizationById', function() { + it('should call getDraftLocalizationById successfully', function(done) { + //uncomment below and update the code to test getDraftLocalizationById + //instance.getDraftLocalizationById(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); + describe('getPublishedLocalizationById', function() { + it('should call getPublishedLocalizationById successfully', function(done) { + //uncomment below and update the code to test getPublishedLocalizationById + //instance.getPublishedLocalizationById(function(error) { // if (error) throw error; //expect().to.be(); //}); diff --git a/test/api/TemplatesApi.spec.js b/test/api/TemplatesApi.spec.js index 9e53e8c..bd09c1c 100644 --- a/test/api/TemplatesApi.spec.js +++ b/test/api/TemplatesApi.spec.js @@ -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.04 + * 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).