dyspatch_client 3.0.1 → 4.0.0

data/docs/DraftsRead.md

@@ -1,9 +1,19 @@
 # DyspatchClient::DraftsRead
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **cursor** | [**Cursor**](Cursor.md) |  | [optional] 
-**data** | [**Array<DraftMetaRead>**](DraftMetaRead.md) | A list of draft metadata objects | [optional] 
+**data** | [**Array&lt;DraftMetaRead&gt;**](DraftMetaRead.md) | A list of draft metadata objects | [optional] 
+
+## Code Sample
+
+```ruby
+require 'DyspatchClient'
+
+instance = DyspatchClient::DraftsRead.new(cursor: null,
+                                 data: null)
+```
 
 

data/docs/{Body.md → InlineObject.md}

@@ -1,8 +1,17 @@
-# DyspatchClient::Body
+# DyspatchClient::InlineObject
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** |  | [optional] 
 
+## Code Sample
+
+```ruby
+require 'DyspatchClient'
+
+instance = DyspatchClient::InlineObject.new(name: English (US))
+```
+
 

data/docs/LocalizationKeyRead.md

@@ -1,9 +1,19 @@
 # DyspatchClient::LocalizationKeyRead
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **key** | **String** |  | [optional] 
 **comment** | **String** |  | [optional] 
 
+## Code Sample
+
+```ruby
+require 'DyspatchClient'
+
+instance = DyspatchClient::LocalizationKeyRead.new(key: null,
+                                 comment: null)
+```
+
 

data/docs/LocalizationMetaRead.md

@@ -1,12 +1,23 @@
 # DyspatchClient::LocalizationMetaRead
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **String** | An opaque, unique identifier for a localization | [optional] 
-**language** | **String** | A language identifier comprised of a language and a country identifier.  See [supported languages](https://docs.dyspatch.io/localization/supported_languages/).  | [optional] 
+**localization** | **String** | An opaque, unique identifier for a localization | [optional] 
+**language** | **String** | A language identifier comprised of a language and a country identifier. See [supported languages](https://docs.dyspatch.io/localization/supported_languages/).  | [optional] 
 **name** | **String** | The user-specified name of a localization | [optional] 
 **url** | **String** | The API url for a specific localization | [optional] 
-**draft** | **String** | An opaque, unique identifier for a draft | [optional] 
+
+## Code Sample
+
+```ruby
+require 'DyspatchClient'
+
+instance = DyspatchClient::LocalizationMetaRead.new(localization: loc_g3L7Cw6Hp5wUaf395LehwK,
+                                 language: en-US,
+                                 name: English (US),
+                                 url: /localizations/loc_g3L7Cw6Hp5wUaf395LehwK)
+```
 
 

data/docs/LocalizationRead.md

@@ -1,10 +1,11 @@
 # DyspatchClient::LocalizationRead
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **String** | An opaque, unique identifier for a localization | [optional] 
-**language** | **String** | A language identifier comprised of a language and a country identifier.  See [supported languages](https://docs.dyspatch.io/localization/supported_languages/).  | [optional] 
+**language** | **String** | A language identifier comprised of a language and a country identifier. See [supported languages](https://docs.dyspatch.io/localization/supported_languages/).  | [optional] 
 **url** | **String** | The API url for a specific localization | [optional] 
 **template** | **String** | An opaque, unique identifier for a template | [optional] 
 **compiled** | [**CompiledRead**](CompiledRead.md) |  | [optional] 
@@ -12,4 +13,19 @@ Name | Type | Description | Notes
 **updated_at** | **DateTime** | The time of last update | [optional] 
 **name** | **String** | The user-specified name of a localization | [optional] 
 
+## Code Sample
+
+```ruby
+require 'DyspatchClient'
+
+instance = DyspatchClient::LocalizationRead.new(id: loc_g3L7Cw6Hp5wUaf395LehwK,
+                                 language: en-US,
+                                 url: /localizations/loc_g3L7Cw6Hp5wUaf395LehwK,
+                                 template: tem_g3L7Cw6Hp5wU,
+                                 compiled: null,
+                                 created_at: null,
+                                 updated_at: null,
+                                 name: English (US))
+```
+
 

data/docs/LocalizationsApi.md

@@ -4,17 +4,20 @@ All URIs are relative to *https://api.dyspatch.io*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**localizations_localization_id_get**](LocalizationsApi.md#localizations_localization_id_get) | **GET** /localizations/{localizationId} | Get Localization Object by ID
+[**get_localization_by_id**](LocalizationsApi.md#get_localization_by_id) | **GET** /localizations/{localizationId} | Get Localization Object by ID
 
 
-# **localizations_localization_id_get**
-> LocalizationRead localizations_localization_id_get(localization_id, target_language)
+
+## get_localization_by_id
+
+> LocalizationRead get_localization_by_id(localization_id, target_language, accept)
 
 Get Localization Object by ID
 
-Returns a specific localization object with a matching ID.
+Returns a specific localization object with a matching ID
 
 ### Example
+
 ```ruby
 # load the gem
 require 'dyspatch_client'
@@ -27,27 +30,27 @@ DyspatchClient.configure do |config|
 end
 
 api_instance = DyspatchClient::LocalizationsApi.new
-
 localization_id = 'localization_id_example' # String | A localization 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 \"2019.10\", set the value to \"application/vnd.dyspatch.2019.10+json\"
 
 begin
   #Get Localization Object by ID
-  result = api_instance.localizations_localization_id_get(localization_id, target_language)
+  result = api_instance.get_localization_by_id(localization_id, target_language, accept)
   p result
 rescue DyspatchClient::ApiError => e
-  puts "Exception when calling LocalizationsApi->localizations_localization_id_get: #{e}"
+  puts "Exception when calling LocalizationsApi->get_localization_by_id: #{e}"
 end
 ```
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **localization_id** | **String**| A localization 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 \"2019.10\", set the value to \"application/vnd.dyspatch.2019.10+json\" | 
 
 ### Return type
 
@@ -59,8 +62,6 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
- - **Accept**: application/vnd.dyspatch.2019.10+json
-
-
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.dyspatch.2019.10+json, */*
 

data/docs/TemplateMetaRead.md

@@ -1,14 +1,29 @@
 # DyspatchClient::TemplateMetaRead
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **String** | An opaque, unique identifier for a template | [optional] 
 **name** | **String** | The name of a template | [optional] 
 **description** | **String** | A description of the template | [optional] 
 **url** | **String** | The API url for a specific template | [optional] 
-**localizations** | [**Array<LocalizationMetaRead>**](LocalizationMetaRead.md) | A list of the template's available localization objects | [optional] 
+**localizations** | [**Array&lt;LocalizationMetaRead&gt;**](LocalizationMetaRead.md) | A list of the template&#39;s available localization objects | [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::TemplateMetaRead.new(id: tem_g3L7Cw6Hp5wU,
+                                 name: null,
+                                 description: null,
+                                 url: /templates/tem_g3L7Cw6Hp5wUaf395LehwK,
+                                 localizations: null,
+                                 created_at: null,
+                                 updated_at: null)
+```
+
 

data/docs/TemplateRead.md

@@ -1,6 +1,7 @@
 # DyspatchClient::TemplateRead
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **String** | An opaque, unique identifier for a template | [optional] 
@@ -10,6 +11,21 @@ Name | Type | Description | Notes
 **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] 
+**localizations** | [**Array&lt;LocalizationMetaRead&gt;**](LocalizationMetaRead.md) | A list of the Template&#39;s available localizations | [optional] 
+
+## Code Sample
+
+```ruby
+require 'DyspatchClient'
+
+instance = DyspatchClient::TemplateRead.new(id: tem_g3L7Cw6Hp5wU,
+                                 name: null,
+                                 description: null,
+                                 url: /templates/tem_g3L7Cw6Hp5wUaf395LehwK,
+                                 compiled: null,
+                                 created_at: null,
+                                 updated_at: null,
+                                 localizations: null)
+```
 
 

data/docs/TemplatesApi.md

@@ -4,18 +4,21 @@ All URIs are relative to *https://api.dyspatch.io*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**templates_get**](TemplatesApi.md#templates_get) | **GET** /templates | List Templates
-[**templates_template_id_get**](TemplatesApi.md#templates_template_id_get) | **GET** /templates/{templateId} | Get Template by ID
+[**get_template_by_id**](TemplatesApi.md#get_template_by_id) | **GET** /templates/{templateId} | Get Template by ID
+[**get_templates**](TemplatesApi.md#get_templates) | **GET** /templates | List Templates
 
 
-# **templates_get**
-> TemplatesRead templates_get(opts)
 
-List Templates
+## get_template_by_id
 
-Gets a list of Template Metadata objects for all templates. Up to 25 results returned before results are paginated.
+> TemplateRead get_template_by_id(template_id, target_language, accept)
+
+Get Template by ID
+
+Gets a template object with the matching ID. If the template has published content the \"compiled\" field will contain the template .
 
 ### Example
+
 ```ruby
 # load the gem
 require 'dyspatch_client'
@@ -28,29 +31,31 @@ DyspatchClient.configure do |config|
 end
 
 api_instance = DyspatchClient::TemplatesApi.new
-
-opts = { 
-  cursor: 'cursor_example', # String | A cursor value used to retrieve a specific page from a paginated result set.
-}
+template_id = 'template_id_example' # String | A template 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 \"2019.10\", set the value to \"application/vnd.dyspatch.2019.10+json\"
 
 begin
-  #List Templates
-  result = api_instance.templates_get(opts)
+  #Get Template by ID
+  result = api_instance.get_template_by_id(template_id, target_language, accept)
   p result
 rescue DyspatchClient::ApiError => e
-  puts "Exception when calling TemplatesApi->templates_get: #{e}"
+  puts "Exception when calling TemplatesApi->get_template_by_id: #{e}"
 end
 ```
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **cursor** | **String**| A cursor value used to retrieve a specific page from a paginated result set. | [optional] 
+ **template_id** | **String**| A template 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 \"2019.10\", set the value to \"application/vnd.dyspatch.2019.10+json\" | 
 
 ### Return type
 
-[**TemplatesRead**](TemplatesRead.md)
+[**TemplateRead**](TemplateRead.md)
 
 ### Authorization
 
@@ -58,19 +63,20 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
- - **Accept**: application/vnd.dyspatch.2019.10+json
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.dyspatch.2019.10+json, */*
 
 
+## get_templates
 
-# **templates_template_id_get**
-> TemplateRead templates_template_id_get(template_id, target_language)
+> TemplatesRead get_templates(accept, opts)
 
-Get Template by ID
+List Templates
 
-Gets a template object with the matching ID. If the template has published content the "compiled" field will contain the template .
+Gets a list of Template Metadata objects for all templates. Up to 25 results returned before results are paginated.
 
 ### Example
+
 ```ruby
 # load the gem
 require 'dyspatch_client'
@@ -83,31 +89,31 @@ DyspatchClient.configure do |config|
 end
 
 api_instance = DyspatchClient::TemplatesApi.new
-
-template_id = 'template_id_example' # String | A template 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 \"2019.10\", set the value to \"application/vnd.dyspatch.2019.10+json\"
+opts = {
+  cursor: 'cursor_example' # String | A cursor value used to retrieve a specific page from a paginated result set.
+}
 
 begin
-  #Get Template by ID
-  result = api_instance.templates_template_id_get(template_id, target_language)
+  #List Templates
+  result = api_instance.get_templates(accept, opts)
   p result
 rescue DyspatchClient::ApiError => e
-  puts "Exception when calling TemplatesApi->templates_template_id_get: #{e}"
+  puts "Exception when calling TemplatesApi->get_templates: #{e}"
 end
 ```
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **template_id** | **String**| A template 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 \"2019.10\", set the value to \"application/vnd.dyspatch.2019.10+json\" | 
+ **cursor** | **String**| A cursor value used to retrieve a specific page from a paginated result set. | [optional] 
 
 ### Return type
 
-[**TemplateRead**](TemplateRead.md)
+[**TemplatesRead**](TemplatesRead.md)
 
 ### Authorization
 
@@ -115,8 +121,6 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
- - **Accept**: application/vnd.dyspatch.2019.10+json
-
-
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.dyspatch.2019.10+json, */*
 

data/docs/TemplatesRead.md

@@ -1,9 +1,19 @@
 # DyspatchClient::TemplatesRead
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **cursor** | [**Cursor**](Cursor.md) |  | [optional] 
-**data** | [**Array<TemplateMetaRead>**](TemplateMetaRead.md) | A list of template metadata objects | [optional] 
+**data** | [**Array&lt;TemplateMetaRead&gt;**](TemplateMetaRead.md) | A list of template metadata objects | [optional] 
+
+## Code Sample
+
+```ruby
+require 'DyspatchClient'
+
+instance = DyspatchClient::TemplatesRead.new(cursor: null,
+                                 data: null)
+```
 
 

data/dyspatch_client.gemspec

@@ -3,12 +3,12 @@
 =begin
 #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 the following 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) 
+## 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)  
 
-OpenAPI spec version: 2019.10
+The version of the OpenAPI document: 2019.10
 Contact: support@dyspatch.io
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.10
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.2.3-SNAPSHOT
 
 =end
 
@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
   s.email       = ["support@dyspatch.io"]
   s.homepage    = "https://www.dyspatch.io"
   s.summary     = "Dyspatch is an email production platform that helps teams create and change emails faster. See https://www.dyspatch.io for more information."
-  s.description = "# 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 the following 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) "
+  s.description = "# 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)  "
   s.license     = 'Apache-2.0'
   s.required_ruby_version = ">= 1.9"
 
@@ -31,12 +31,6 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
 
   s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
-  s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
-  s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
-  s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
-  s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
-  s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
-  s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
 
   s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
   s.test_files    = `find spec/*`.split("\n")