dyspatch_client 2.0.0 → 5.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 186daaf94c5a9a3dff6c571280a8502175c39bb6f12714e0d8da88c949a4c6fa
-  data.tar.gz: a5c5e4b3e944805de6d407c4fbabe41dacc40fb13348db01b6d1adde04316a79
+  metadata.gz: efc7d9ea4c7fcb547486a77d1f04877f8fbdd412501b3a7bea81fbc6a0d5b3c4
+  data.tar.gz: b7f721a5488733bd98ac18609e6d8f776d78b1278008f04536fbf65bb29c4f11
 SHA512:
-  metadata.gz: 50f2c2ae41235ff6e3ff5fcd11a79e1daa75ee28469ac7cffe386c57df601eb0b1222db67908d73273d8dbf66fb0ae993bf0052c027ddf470b596bd99fa9f8ae
-  data.tar.gz: 7671fa4aa1642199e9750c109a7045823cddc6755349dfff2d42044a234eb17020d3a56ea88dd854d99d42b8b9b548710e12aad29d860b42b1a413da0e320d7b
+  metadata.gz: 4bb84b56ba3e0250ff3a23401feba616e5d055e1dee3f581f6cf2fdfe771fb792739cafb1e3c5300b4b9b792d67a0e3a631b552b8b511249141566b840b9afa5
+  data.tar.gz: '08494dc1e12148ddf48ff7e30f090514c69da14665cebea973be5e788272661a53d96f0a29fb92398f5ca167a4924f5108767a781df5cef4c5856b4a2d06d9ad'

data/Gemfile

@@ -3,5 +3,7 @@ source 'https://rubygems.org'
 gemspec
 
 group :development, :test do
-  gem 'rake', '~> 12.0.0'
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
 end

data/README.md

@@ -2,23 +2,29 @@
 
 DyspatchClient - the Ruby gem for the Dyspatch API
 
-# Introduction  
+# 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.  
+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) 
+## API Client Libraries
+Dyspatch provides API Clients for popular languages and web frameworks.
 
-This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+- [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)
 
-- API version: 2019.03
-- Package version: 2.0.0
-- Build package: io.swagger.codegen.languages.RubyClientCodegen
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 2020.04
+- Package version: 5.0.1
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [https://docs.dyspatch.io](https://docs.dyspatch.io)
 
 ## Installation
@@ -34,21 +40,22 @@ gem build dyspatch_client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./dyspatch_client-2.0.0.gem
+gem install ./dyspatch_client-5.0.1.gem
 ```
-(for development, run `gem install --dev ./dyspatch_client-2.0.0.gem` to install the development dependencies)
+
+(for development, run `gem install --dev ./dyspatch_client-5.0.1.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'dyspatch_client', '~> 2.0.0'
+    gem 'dyspatch_client', '~> 5.0.1'
 
 ### Install from Git
 
-If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+If the Ruby gem is hosted at a git repository: https://github.com/getdyspatch/dyspatch-ruby, then add the following in the Gemfile:
 
-    gem 'dyspatch_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+    gem 'dyspatch_client', :git => 'https://github.com/getdyspatch/dyspatch-ruby.git'
 
 ### Include the Ruby code directly
 
@@ -61,6 +68,7 @@ ruby -Ilib script.rb
 ## Getting Started
 
 Please follow the [installation](#installation) procedure and then run the following code:
+
 ```ruby
 # Load the gem
 require 'dyspatch_client'
@@ -73,21 +81,16 @@ DyspatchClient.configure do |config|
   #config.api_key_prefix['Authorization'] = 'Bearer'
 end
 
-api_instance = DyspatchClient::LocalizationsApi.new
-
-localization_id = "localization_id_example" # String | A localization ID
-
-opts = { 
-  target_language: "target_language_example", # String | The type of templating language to compile as. Should only be used for visual templates.
-  accept: "accept_example" # String | A version of the API that should be used for the request. For example, to use version "2019.03", set the value to "application/vnd.dyspatch.2019.03+json"
-}
+api_instance = DyspatchClient::DraftsApi.new
+draft_id = 'draft_id_example' # String | A draft ID
+language_id = 'language_id_example' # String | A language ID (eg: en-US)
+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\"
 
 begin
-  #Get Localization Object by ID
-  result = api_instance.localizations_localization_id_get(localization_id, opts)
-  p result
+  #Remove a localization
+  api_instance.delete_localization(draft_id, language_id, accept)
 rescue DyspatchClient::ApiError => e
-  puts "Exception when calling LocalizationsApi->localizations_localization_id_get: #{e}"
+  puts "Exception when calling DraftsApi->delete_localization: #{e}"
 end
 
 ```
@@ -98,9 +101,17 @@ All URIs are relative to *https://api.dyspatch.io*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
-*DyspatchClient::LocalizationsApi* | [**localizations_localization_id_get**](docs/LocalizationsApi.md#localizations_localization_id_get) | **GET** /localizations/{localizationId} | Get Localization Object by ID
-*DyspatchClient::TemplatesApi* | [**templates_get**](docs/TemplatesApi.md#templates_get) | **GET** /templates | List Templates
-*DyspatchClient::TemplatesApi* | [**templates_template_id_get**](docs/TemplatesApi.md#templates_template_id_get) | **GET** /templates/{templateId} | Get Template by ID
+*DyspatchClient::DraftsApi* | [**delete_localization**](docs/DraftsApi.md#delete_localization) | **DELETE** /drafts/{draftId}/localizations/{languageId} | Remove a localization
+*DyspatchClient::DraftsApi* | [**get_draft_by_id**](docs/DraftsApi.md#get_draft_by_id) | **GET** /drafts/{draftId} | Get Draft by ID
+*DyspatchClient::DraftsApi* | [**get_draft_localization_keys**](docs/DraftsApi.md#get_draft_localization_keys) | **GET** /drafts/{draftId}/localizationKeys | Get localization keys
+*DyspatchClient::DraftsApi* | [**get_drafts**](docs/DraftsApi.md#get_drafts) | **GET** /drafts | List Drafts
+*DyspatchClient::DraftsApi* | [**get_localization_for_draft**](docs/DraftsApi.md#get_localization_for_draft) | **GET** /drafts/{draftId}/localizations | Get localizations on a draft
+*DyspatchClient::DraftsApi* | [**save_localization**](docs/DraftsApi.md#save_localization) | **PUT** /drafts/{draftId}/localizations/{languageId} | Create or update a localization
+*DyspatchClient::DraftsApi* | [**set_translation**](docs/DraftsApi.md#set_translation) | **PUT** /drafts/{draftId}/localizations/{languageId}/translations | Set translations for language
+*DyspatchClient::DraftsApi* | [**submit_draft_for_approval**](docs/DraftsApi.md#submit_draft_for_approval) | **POST** /drafts/{draftId}/publishRequest | Submit the draft for approval
+*DyspatchClient::LocalizationsApi* | [**get_localization_by_id**](docs/LocalizationsApi.md#get_localization_by_id) | **GET** /localizations/{localizationId} | Get Localization Object by ID
+*DyspatchClient::TemplatesApi* | [**get_template_by_id**](docs/TemplatesApi.md#get_template_by_id) | **GET** /templates/{templateId} | Get Template by ID
+*DyspatchClient::TemplatesApi* | [**get_templates**](docs/TemplatesApi.md#get_templates) | **GET** /templates | List Templates
 
 
 ## Documentation for Models
@@ -108,6 +119,11 @@ Class | Method | HTTP request | Description
  - [DyspatchClient::APIError](docs/APIError.md)
  - [DyspatchClient::CompiledRead](docs/CompiledRead.md)
  - [DyspatchClient::Cursor](docs/Cursor.md)
+ - [DyspatchClient::DraftMetaRead](docs/DraftMetaRead.md)
+ - [DyspatchClient::DraftRead](docs/DraftRead.md)
+ - [DyspatchClient::DraftsRead](docs/DraftsRead.md)
+ - [DyspatchClient::InlineObject](docs/InlineObject.md)
+ - [DyspatchClient::LocalizationKeyRead](docs/LocalizationKeyRead.md)
  - [DyspatchClient::LocalizationMetaRead](docs/LocalizationMetaRead.md)
  - [DyspatchClient::LocalizationRead](docs/LocalizationRead.md)
  - [DyspatchClient::TemplateMetaRead](docs/TemplateMetaRead.md)
@@ -120,7 +136,7 @@ Class | Method | HTTP request | Description
 
 ### Bearer
 
+
 - **Type**: API key
 - **API key parameter name**: Authorization
 - **Location**: HTTP header
-

data/Rakefile

@@ -1,3 +1,5 @@
+require "bundler/gem_tasks"
+
 begin
   require 'rspec/core/rake_task'
 

data/docs/APIError.md

@@ -1,10 +1,21 @@
 # DyspatchClient::APIError
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**code** | **String** | Error code:   * server_error - Internal server error.   * invalid_parameter - Validation error, parameter will contain invalid field and message will contain the reason.   * invalid_body - Body could not be parsed, message will contain the reason.   * invalid_request - Validation error, the protocol used to make the request was not https.   * unauthorized - Credentials were found but permissions were not sufficient.   * unauthenticated - Credentials were not found or were not valid.   * not_found - The requested resource was not found.   * rate_limited - The request was refused because a rate limit was exceeded. There is an account wide rate limit of 3600 requests per-minute, although that is subject to change. The current remaining rate limit can be viewed by checking the X-Ratelimit-Remaining header.  | [optional] 
+**code** | **String** | Error code:   * server_error - Internal server error.   * invalid_parameter - Validation error, parameter will contain invalid field and message will contain the reason.   * invalid_body - Body could not be parsed, message will contain the reason.   * invalid_request - Validation error, the protocol used to make the request was not https.   * unauthorized - Credentials were found but permissions were not sufficient.   * unauthenticated - Credentials were not found or were not valid.   * not_found - The requested resource was not found.   * rate_limited - The request was refused because a rate limit was exceeded. There is an account wide rate limit of 3600 requests per-minute, although that is subject to change. The current remaining rate limit can be viewed by checking the X-Ratelimit-Remaining header.   * prohibited_action - The request was refused because an action was not valid for the requested resource. Typically this will happen if you try to make changes to a locked resource.  | [optional] 
 **message** | **String** | Human readable error message | [optional] 
 **parameter** | **String** | The invalid parameter, if 'code' is invalid_parameter | [optional] 
 
+## Code Sample
+
+```ruby
+require 'DyspatchClient'
+
+instance = DyspatchClient::APIError.new(code: null,
+                                 message: null,
+                                 parameter: null)
+```
+
 

data/docs/CompiledRead.md

@@ -1,6 +1,7 @@
 # DyspatchClient::CompiledRead
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **sender** | **String** | Sender address | [optional] 
@@ -9,4 +10,16 @@ Name | Type | Description | Notes
 **html** | **String** | Base64 encoded template HTML body | [optional] 
 **text** | **String** | Base64 encoded template text body | [optional] 
 
+## Code Sample
+
+```ruby
+require 'DyspatchClient'
+
+instance = DyspatchClient::CompiledRead.new(sender: Example,
+                                 reply_to: Example,
+                                 subject: null,
+                                 html: null,
+                                 text: null)
+```
+
 

data/docs/Cursor.md

@@ -1,9 +1,19 @@
 # DyspatchClient::Cursor
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **_next** | **String** | A cursor to fetch the next page of results | [optional] 
-**has_more** | **BOOLEAN** | Whether there is a next page of results | [optional] 
+**has_more** | **Boolean** | Whether there is a next page of results | [optional] 
+
+## Code Sample
+
+```ruby
+require 'DyspatchClient'
+
+instance = DyspatchClient::Cursor.new(_next: null,
+                                 has_more: null)
+```
 
 

data/docs/DraftMetaRead.md

@@ -0,0 +1,27 @@
+# DyspatchClient::DraftMetaRead
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | An opaque, unique identifier for a draft | [optional] 
+**template_id** | **String** | An opaque, unique identifier for a template | [optional] 
+**name** | **String** | The name of a draft | [optional] 
+**url** | **String** | The API url for a specific draft | [optional] 
+**created_at** | **DateTime** | The time of initial creation | [optional] 
+**updated_at** | **DateTime** | The time of last update | [optional] 
+
+## Code Sample
+
+```ruby
+require 'DyspatchClient'
+
+instance = DyspatchClient::DraftMetaRead.new(id: tdft_g3L7Cw6Hp5wU,
+                                 template_id: tem_g3L7Cw6Hp5wU,
+                                 name: null,
+                                 url: /drafts/tdft_g3L7Cw6Hp5wUaf395LehwK/dft_g3L7Cw6Hp5wU,
+                                 created_at: null,
+                                 updated_at: null)
+```
+
+

data/docs/DraftRead.md

@@ -0,0 +1,31 @@
+# DyspatchClient::DraftRead
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | An opaque, unique identifier for a draft | [optional] 
+**template** | **String** | An opaque, unique identifier for a template | [optional] 
+**name** | **String** | The name of a draft | [optional] 
+**url** | **String** | The API url for a specific draft | [optional] 
+**compiled** | [**CompiledRead**](CompiledRead.md) |  | [optional] 
+**created_at** | **DateTime** | The time of initial creation | [optional] 
+**updated_at** | **DateTime** | The time of last update | [optional] 
+**localizations** | [**Array<LocalizationMetaRead>**](LocalizationMetaRead.md) | A list of the Template's available localizations | [optional] 
+
+## Code Sample
+
+```ruby
+require 'DyspatchClient'
+
+instance = DyspatchClient::DraftRead.new(id: tdft_g3L7Cw6Hp5wU,
+                                 template: tem_g3L7Cw6Hp5wU,
+                                 name: null,
+                                 url: /drafts/tdft_g3L7Cw6Hp5wUaf395LehwK/dft_g3L7Cw6Hp5wU,
+                                 compiled: null,
+                                 created_at: null,
+                                 updated_at: null,
+                                 localizations: null)
+```
+
+

data/docs/DraftsApi.md

@@ -0,0 +1,476 @@
+# DyspatchClient::DraftsApi
+
+All URIs are relative to *https://api.dyspatch.io*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_localization**](DraftsApi.md#delete_localization) | **DELETE** /drafts/{draftId}/localizations/{languageId} | Remove a localization
+[**get_draft_by_id**](DraftsApi.md#get_draft_by_id) | **GET** /drafts/{draftId} | Get Draft by ID
+[**get_draft_localization_keys**](DraftsApi.md#get_draft_localization_keys) | **GET** /drafts/{draftId}/localizationKeys | Get localization keys
+[**get_drafts**](DraftsApi.md#get_drafts) | **GET** /drafts | List Drafts
+[**get_localization_for_draft**](DraftsApi.md#get_localization_for_draft) | **GET** /drafts/{draftId}/localizations | Get localizations on a draft
+[**save_localization**](DraftsApi.md#save_localization) | **PUT** /drafts/{draftId}/localizations/{languageId} | Create or update a localization
+[**set_translation**](DraftsApi.md#set_translation) | **PUT** /drafts/{draftId}/localizations/{languageId}/translations | Set translations for language
+[**submit_draft_for_approval**](DraftsApi.md#submit_draft_for_approval) | **POST** /drafts/{draftId}/publishRequest | Submit the draft for approval
+
+
+
+## delete_localization
+
+> delete_localization(draft_id, language_id, accept)
+
+Remove a localization
+
+Deletes the localization with the given language ID if it exists
+
+### Example
+
+```ruby
+# load the gem
+require 'dyspatch_client'
+# setup authorization
+DyspatchClient.configure do |config|
+  # Configure API key authorization: Bearer
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = DyspatchClient::DraftsApi.new
+draft_id = 'draft_id_example' # String | A draft ID
+language_id = 'language_id_example' # String | A language ID (eg: en-US)
+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\"
+
+begin
+  #Remove a localization
+  api_instance.delete_localization(draft_id, language_id, accept)
+rescue DyspatchClient::ApiError => e
+  puts "Exception when calling DraftsApi->delete_localization: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **draft_id** | **String**| A draft ID | 
+ **language_id** | **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\" | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## get_draft_by_id
+
+> DraftRead get_draft_by_id(draft_id, target_language, accept)
+
+Get Draft by ID
+
+Gets a draft object with the matching ID. The \"compiled\" field will contain the template in the default, unlocalized form.
+
+### Example
+
+```ruby
+# load the gem
+require 'dyspatch_client'
+# setup authorization
+DyspatchClient.configure do |config|
+  # Configure API key authorization: Bearer
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = DyspatchClient::DraftsApi.new
+draft_id = 'draft_id_example' # String | A draft ID
+target_language = 'target_language_example' # String | The type of templating language to compile as. Should only be used for visual templates.
+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\"
+
+begin
+  #Get Draft by ID
+  result = api_instance.get_draft_by_id(draft_id, target_language, accept)
+  p result
+rescue DyspatchClient::ApiError => e
+  puts "Exception when calling DraftsApi->get_draft_by_id: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **draft_id** | **String**| A draft ID | 
+ **target_language** | **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\" | 
+
+### Return type
+
+[**DraftRead**](DraftRead.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.dyspatch.2020.04+json, */*
+
+
+## get_draft_localization_keys
+
+> Array<LocalizationKeyRead> get_draft_localization_keys(draft_id, accept)
+
+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.
+
+### Example
+
+```ruby
+# load the gem
+require 'dyspatch_client'
+# setup authorization
+DyspatchClient.configure do |config|
+  # Configure API key authorization: Bearer
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = DyspatchClient::DraftsApi.new
+draft_id = 'draft_id_example' # String | A draft ID
+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\"
+
+begin
+  #Get localization keys
+  result = api_instance.get_draft_localization_keys(draft_id, accept)
+  p result
+rescue DyspatchClient::ApiError => e
+  puts "Exception when calling DraftsApi->get_draft_localization_keys: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **draft_id** | **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\" | 
+
+### Return type
+
+[**Array<LocalizationKeyRead>**](LocalizationKeyRead.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.dyspatch.2020.04+json, text/vnd.dyspatch.2020.04+x-gettext-translation
+
+
+## get_drafts
+
+> DraftsRead get_drafts(accept, opts)
+
+List Drafts
+
+Returns all drafts for your organization.
+
+### Example
+
+```ruby
+# load the gem
+require 'dyspatch_client'
+# setup authorization
+DyspatchClient.configure do |config|
+  # Configure API key authorization: Bearer
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = DyspatchClient::DraftsApi.new
+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\"
+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
+}
+
+begin
+  #List Drafts
+  result = api_instance.get_drafts(accept, opts)
+  p result
+rescue DyspatchClient::ApiError => e
+  puts "Exception when calling DraftsApi->get_drafts: #{e}"
+end
+```
+
+### Parameters
+
+
+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\" | 
+ **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] 
+
+### Return type
+
+[**DraftsRead**](DraftsRead.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.dyspatch.2020.04+json, */*
+
+
+## get_localization_for_draft
+
+> Array<LocalizationMetaRead> get_localization_for_draft(draft_id, accept)
+
+Get localizations on a draft
+
+Returns localization metadata for the draft
+
+### Example
+
+```ruby
+# load the gem
+require 'dyspatch_client'
+# setup authorization
+DyspatchClient.configure do |config|
+  # Configure API key authorization: Bearer
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = DyspatchClient::DraftsApi.new
+draft_id = 'draft_id_example' # String | A draft ID
+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\"
+
+begin
+  #Get localizations on a draft
+  result = api_instance.get_localization_for_draft(draft_id, accept)
+  p result
+rescue DyspatchClient::ApiError => e
+  puts "Exception when calling DraftsApi->get_localization_for_draft: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **draft_id** | **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\" | 
+
+### Return type
+
+[**Array<LocalizationMetaRead>**](LocalizationMetaRead.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.dyspatch.2020.04+json
+
+
+## save_localization
+
+> save_localization(draft_id, language_id, accept, inline_object)
+
+Create or update a localization
+
+Inserts a localization or sets the name on an existing localization that already uses the languageId
+
+### Example
+
+```ruby
+# load the gem
+require 'dyspatch_client'
+# setup authorization
+DyspatchClient.configure do |config|
+  # Configure API key authorization: Bearer
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = DyspatchClient::DraftsApi.new
+draft_id = 'draft_id_example' # String | A draft ID
+language_id = 'language_id_example' # String | A language ID (eg: en-US)
+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\"
+inline_object = DyspatchClient::InlineObject.new # InlineObject | 
+
+begin
+  #Create or update a localization
+  api_instance.save_localization(draft_id, language_id, accept, inline_object)
+rescue DyspatchClient::ApiError => e
+  puts "Exception when calling DraftsApi->save_localization: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **draft_id** | **String**| A draft ID | 
+ **language_id** | **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\" | 
+ **inline_object** | [**InlineObject**](InlineObject.md)|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: Not defined
+
+
+## set_translation
+
+> set_translation(draft_id, language_id, accept, request_body)
+
+Set translations for language
+
+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`.
+
+### Example
+
+```ruby
+# load the gem
+require 'dyspatch_client'
+# setup authorization
+DyspatchClient.configure do |config|
+  # Configure API key authorization: Bearer
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = DyspatchClient::DraftsApi.new
+draft_id = 'draft_id_example' # String | A draft ID
+language_id = 'language_id_example' # String | A language ID (eg: en-US)
+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\"
+request_body = {'key' => 'request_body_example'} # Hash<String, String> | 
+
+begin
+  #Set translations for language
+  api_instance.set_translation(draft_id, language_id, accept, request_body)
+rescue DyspatchClient::ApiError => e
+  puts "Exception when calling DraftsApi->set_translation: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **draft_id** | **String**| A draft ID | 
+ **language_id** | **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 \&quot;2020.04\&quot;, set the value to \&quot;application/vnd.dyspatch.2020.04+json\&quot; | 
+ **request_body** | [**Hash&lt;String, String&gt;**](String.md)|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: */*
+
+
+## submit_draft_for_approval
+
+> submit_draft_for_approval(draft_id, accept)
+
+Submit the draft for approval
+
+Moves the draft into submitted state.
+
+### Example
+
+```ruby
+# load the gem
+require 'dyspatch_client'
+# setup authorization
+DyspatchClient.configure do |config|
+  # Configure API key authorization: Bearer
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = DyspatchClient::DraftsApi.new
+draft_id = 'draft_id_example' # String | A draft ID
+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\"
+
+begin
+  #Submit the draft for approval
+  api_instance.submit_draft_for_approval(draft_id, accept)
+rescue DyspatchClient::ApiError => e
+  puts "Exception when calling DraftsApi->submit_draft_for_approval: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **draft_id** | **String**| A draft ID | 
+ **accept** | **String**| A version of the API that should be used for the request. For example, to use version \&quot;2020.04\&quot;, set the value to \&quot;application/vnd.dyspatch.2020.04+json\&quot; | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: */*
+