dyspatch_client 1.0.0

data/docs/LocalizationRead.md

@@ -0,0 +1,15 @@
+# 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] 
+**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] 
+**created_at** | **DateTime** | The time of initial creation | [optional] 
+**updated_at** | **DateTime** | The time of last update | [optional] 
+**name** | **String** | The user-specified name of a localization | [optional] 
+
+

data/docs/LocalizationUrl.md

@@ -0,0 +1,7 @@
+# DyspatchClient::LocalizationUrl
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/LocalizationsApi.md

@@ -0,0 +1,66 @@
+# DyspatchClient::LocalizationsApi
+
+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
+
+
+# **localizations_localization_id_get**
+> LocalizationRead localizations_localization_id_get(localization_id, accept)
+
+Get Localization Object by ID
+
+Returns a specific localization object with a matching ID
+
+### 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::LocalizationsApi.new
+
+localization_id = "localization_id_example" # String | A localization ID
+
+accept = "accept_example" # String | A version of the API that should be used for the request. For example, to use version \"2018.08\", set the value to \"application/vnd.dyspatch.2018.08+json\"
+
+
+begin
+  #Get Localization Object by ID
+  result = api_instance.localizations_localization_id_get(localization_id, accept)
+  p result
+rescue DyspatchClient::ApiError => e
+  puts "Exception when calling LocalizationsApi->localizations_localization_id_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **localization_id** | **String**| A localization ID | 
+ **accept** | **String**| A version of the API that should be used for the request. For example, to use version \"2018.08\", set the value to \"application/vnd.dyspatch.2018.08+json\" | 
+
+### Return type
+
+[**LocalizationRead**](LocalizationRead.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.dyspatch.2018.08+json
+
+
+

data/docs/TemplateDescription.md

@@ -0,0 +1,7 @@
+# DyspatchClient::TemplateDescription
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/TemplateId.md

@@ -0,0 +1,7 @@
+# DyspatchClient::TemplateId
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/TemplateMetaRead.md

@@ -0,0 +1,14 @@
+# 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] 
+**created_at** | **DateTime** | The time of initial creation | [optional] 
+**updated_at** | **DateTime** | The time of last update | [optional] 
+
+

data/docs/TemplateName.md

@@ -0,0 +1,7 @@
+# DyspatchClient::TemplateName
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/TemplateRead.md

@@ -0,0 +1,15 @@
+# DyspatchClient::TemplateRead
+
+## 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] 
+**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] 
+
+

data/docs/TemplateUrl.md

@@ -0,0 +1,7 @@
+# DyspatchClient::TemplateUrl
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/TemplatesApi.md

@@ -0,0 +1,125 @@
+# DyspatchClient::TemplatesApi
+
+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
+
+
+# **templates_get**
+> TemplatesRead templates_get(accept, opts)
+
+List Templates
+
+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'
+# 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::TemplatesApi.new
+
+accept = "accept_example" # String | A version of the API that should be used for the request. For example, to use version \"2018.08\", set the value to \"application/vnd.dyspatch.2018.08+json\"
+
+opts = { 
+  cursor: "cursor_example" # String | A cursor value used to retrieve a specific page from a paginated result set.
+}
+
+begin
+  #List Templates
+  result = api_instance.templates_get(accept, opts)
+  p result
+rescue DyspatchClient::ApiError => e
+  puts "Exception when calling TemplatesApi->templates_get: #{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 \"2018.08\", set the value to \"application/vnd.dyspatch.2018.08+json\" | 
+ **cursor** | **String**| A cursor value used to retrieve a specific page from a paginated result set. | [optional] 
+
+### Return type
+
+[**TemplatesRead**](TemplatesRead.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.dyspatch.2018.08+json
+
+
+
+# **templates_template_id_get**
+> TemplateRead templates_template_id_get(template_id, 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'
+# 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::TemplatesApi.new
+
+template_id = "template_id_example" # String | A template ID
+
+accept = "accept_example" # String | A version of the API that should be used for the request. For example, to use version \"2018.08\", set the value to \"application/vnd.dyspatch.2018.08+json\"
+
+
+begin
+  #Get Template by ID
+  result = api_instance.templates_template_id_get(template_id, accept)
+  p result
+rescue DyspatchClient::ApiError => e
+  puts "Exception when calling TemplatesApi->templates_template_id_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **template_id** | **String**| A template ID | 
+ **accept** | **String**| A version of the API that should be used for the request. For example, to use version \"2018.08\", set the value to \"application/vnd.dyspatch.2018.08+json\" | 
+
+### Return type
+
+[**TemplateRead**](TemplateRead.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.dyspatch.2018.08+json
+
+
+

data/docs/TemplatesRead.md

@@ -0,0 +1,9 @@
+# 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/docs/UpdatedAt.md

@@ -0,0 +1,7 @@
+# DyspatchClient::UpdatedAt
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/dyspatch_client.gemspec

@@ -0,0 +1,45 @@
+# -*- encoding: utf-8 -*-
+#
+=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 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) 
+
+OpenAPI spec version: 2018.08
+Contact: support@dyspatch.io
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.1
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "dyspatch_client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "dyspatch_client"
+  s.version     = DyspatchClient::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Dyspatch"]
+  s.email       = ["support@dyspatch.io"]
+  s.homepage    = "https://www.dyspatch.io"
+  s.summary     = "Dyspatch is an email production platform that helps Enterprise organizations create and change transactional and triggered 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 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) "
+  s.license     = "Apache-2.0"
+  s.required_ruby_version = ">= 1.9"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  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")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/git_push.sh

@@ -0,0 +1,55 @@
+#!/bin/sh
+#
+# Generated by: https://github.com/swagger-api/swagger-codegen.git
+#
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 swagger-petstore-perl "minor update"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+

data/lib/dyspatch_client.rb

@@ -0,0 +1,59 @@
+=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 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) 
+
+OpenAPI spec version: 2018.08
+Contact: support@dyspatch.io
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.1
+
+=end
+
+# Common files
+require 'dyspatch_client/api_client'
+require 'dyspatch_client/api_error'
+require 'dyspatch_client/version'
+require 'dyspatch_client/configuration'
+
+# Models
+require 'dyspatch_client/models/api_error'
+require 'dyspatch_client/models/compiled_read'
+require 'dyspatch_client/models/created_at'
+require 'dyspatch_client/models/cursor'
+require 'dyspatch_client/models/language_id'
+require 'dyspatch_client/models/localization_id'
+require 'dyspatch_client/models/localization_meta_read'
+require 'dyspatch_client/models/localization_name'
+require 'dyspatch_client/models/localization_read'
+require 'dyspatch_client/models/localization_url'
+require 'dyspatch_client/models/template_description'
+require 'dyspatch_client/models/template_id'
+require 'dyspatch_client/models/template_meta_read'
+require 'dyspatch_client/models/template_name'
+require 'dyspatch_client/models/template_read'
+require 'dyspatch_client/models/template_url'
+require 'dyspatch_client/models/templates_read'
+require 'dyspatch_client/models/updated_at'
+
+# APIs
+require 'dyspatch_client/api/localizations_api'
+require 'dyspatch_client/api/templates_api'
+
+module DyspatchClient
+  class << self
+    # Customize default settings for the SDK using block.
+    #   DyspatchClient.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end