Generate 2020.08

getdyspatch · Sep 10, 2020 · 535fad0 · 535fad0
1 parent 184e153
commit 535fad0
Show file tree

Hide file tree

Showing 36 changed files with 189 additions and 151 deletions.
diff --git a/api/openapi.yaml b/api/openapi.yaml
@@ -23,7 +23,7 @@ info:
     - [Ruby](https://github.com/getdyspatch/dyspatch-ruby)
   termsOfService: https://www.dyspatch.io/legal/terms-of-service/
   title: Dyspatch API
-  version: "2020.04"
+  version: "2020.08"
   x-logo:
     url: /api/dyspatch_logo.png
 servers:
@@ -61,7 +61,7 @@ paths:
           type: string
         style: form
       - description: A version of the API that should be used for the request. For
-          example, to use version "2020.04", set the value to "application/vnd.dyspatch.2020.04+json"
+          example, to use version "2020.08", set the value to "application/vnd.dyspatch.2020.08+json"
         explode: false
         in: header
         name: Accept
@@ -72,7 +72,7 @@ paths:
       responses:
         "200":
           content:
-            application/vnd.dyspatch.2020.04+json:
+            application/vnd.dyspatch.2020.08+json:
               schema:
                 $ref: '#/components/schemas/TemplatesRead'
           description: A list of templates
@@ -166,7 +166,7 @@ paths:
       summary: List Templates
       tags:
       - Templates
-      x-accepts: '*/*,application/vnd.dyspatch.2020.04+json'
+      x-accepts: '*/*,application/vnd.dyspatch.2020.08+json'
   /templates/{templateId}:
     get:
       description: Gets a template object with the matching ID. If the template has
@@ -198,7 +198,7 @@ paths:
           type: string
         style: form
       - description: A version of the API that should be used for the request. For
-          example, to use version "2020.04", set the value to "application/vnd.dyspatch.2020.04+json"
+          example, to use version "2020.08", set the value to "application/vnd.dyspatch.2020.08+json"
         explode: false
         in: header
         name: Accept
@@ -209,7 +209,7 @@ paths:
       responses:
         "200":
           content:
-            application/vnd.dyspatch.2020.04+json:
+            application/vnd.dyspatch.2020.08+json:
               schema:
                 $ref: '#/components/schemas/TemplateRead'
           description: A template object with the requested ID. If the template has
@@ -317,7 +317,7 @@ paths:
       summary: Get Template by ID
       tags:
       - Templates
-      x-accepts: '*/*,application/vnd.dyspatch.2020.04+json'
+      x-accepts: '*/*,application/vnd.dyspatch.2020.08+json'
   /drafts:
     get:
       description: Returns all drafts for your organization.
@@ -343,7 +343,7 @@ paths:
           type: string
         style: form
       - description: A version of the API that should be used for the request. For
-          example, to use version "2020.04", set the value to "application/vnd.dyspatch.2020.04+json"
+          example, to use version "2020.08", set the value to "application/vnd.dyspatch.2020.08+json"
         explode: false
         in: header
         name: Accept
@@ -354,7 +354,7 @@ paths:
       responses:
         "200":
           content:
-            application/vnd.dyspatch.2020.04+json:
+            application/vnd.dyspatch.2020.08+json:
               schema:
                 $ref: '#/components/schemas/DraftsRead'
           description: Drafts
@@ -461,7 +461,7 @@ paths:
       summary: List Drafts
       tags:
       - Drafts
-      x-accepts: '*/*,application/vnd.dyspatch.2020.04+json'
+      x-accepts: '*/*,application/vnd.dyspatch.2020.08+json'
   /drafts/{draftId}/publishRequest:
     post:
       description: Moves the draft into submitted state.
@@ -476,7 +476,7 @@ paths:
           type: string
         style: simple
       - description: A version of the API that should be used for the request. For
-          example, to use version "2020.04", set the value to "application/vnd.dyspatch.2020.04+json"
+          example, to use version "2020.08", set the value to "application/vnd.dyspatch.2020.08+json"
         explode: false
         in: header
         name: Accept
@@ -615,7 +615,7 @@ paths:
           type: string
         style: form
       - description: A version of the API that should be used for the request. For
-          example, to use version "2020.04", set the value to "application/vnd.dyspatch.2020.04+json"
+          example, to use version "2020.08", set the value to "application/vnd.dyspatch.2020.08+json"
         explode: false
         in: header
         name: Accept
@@ -626,7 +626,7 @@ paths:
       responses:
         "200":
           content:
-            application/vnd.dyspatch.2020.04+json:
+            application/vnd.dyspatch.2020.08+json:
               schema:
                 $ref: '#/components/schemas/DraftRead'
           description: A draft object with the requested ID.
@@ -733,7 +733,7 @@ paths:
       summary: Get Draft by ID
       tags:
       - Drafts
-      x-accepts: '*/*,application/vnd.dyspatch.2020.04+json'
+      x-accepts: '*/*,application/vnd.dyspatch.2020.08+json'
   /drafts/{draftId}/localizations:
     get:
       description: Returns localization metadata for the draft
@@ -748,7 +748,7 @@ paths:
           type: string
         style: simple
       - description: A version of the API that should be used for the request. For
-          example, to use version "2020.04", set the value to "application/vnd.dyspatch.2020.04+json"
+          example, to use version "2020.08", set the value to "application/vnd.dyspatch.2020.08+json"
         explode: false
         in: header
         name: Accept
@@ -759,7 +759,7 @@ paths:
       responses:
         "200":
           content:
-            application/vnd.dyspatch.2020.04+json:
+            application/vnd.dyspatch.2020.08+json:
               schema:
                 items:
                   $ref: '#/components/schemas/LocalizationMetaRead'
@@ -777,7 +777,7 @@ paths:
       summary: Get localizations on a draft
       tags:
       - Drafts
-      x-accepts: application/vnd.dyspatch.2020.04+json
+      x-accepts: application/vnd.dyspatch.2020.08+json
   /drafts/{draftId}/localizations/{languageId}:
     delete:
       description: Deletes the localization with the given language ID if it exists
@@ -800,7 +800,7 @@ paths:
           type: string
         style: simple
       - description: A version of the API that should be used for the request. For
-          example, to use version "2020.04", set the value to "application/vnd.dyspatch.2020.04+json"
+          example, to use version "2020.08", set the value to "application/vnd.dyspatch.2020.08+json"
         explode: false
         in: header
         name: Accept
@@ -839,7 +839,7 @@ paths:
           type: string
         style: simple
       - description: A version of the API that should be used for the request. For
-          example, to use version "2020.04", set the value to "application/vnd.dyspatch.2020.04+json"
+          example, to use version "2020.08", set the value to "application/vnd.dyspatch.2020.08+json"
         explode: false
         in: header
         name: Accept
@@ -896,7 +896,7 @@ paths:
           type: string
         style: simple
       - description: A version of the API that should be used for the request. For
-          example, to use version "2020.04", set the value to "application/vnd.dyspatch.2020.04+json"
+          example, to use version "2020.08", set the value to "application/vnd.dyspatch.2020.08+json"
         explode: false
         in: header
         name: Accept
@@ -941,8 +941,8 @@ paths:
   /drafts/{draftId}/localizationKeys:
     get:
       description: Returns the list of values that need to be translated for the draft.
-        Set the `Accept` header to `application/vnd.dyspatch.2020.04+json` to get
-        a JSON object, or `text/vnd.dyspatch.2020.04+x-gettext-translation` to get
+        Set the `Accept` header to `application/vnd.dyspatch.2020.08+json` to get
+        a JSON object, or `text/vnd.dyspatch.2020.08+x-gettext-translation` to get
         the POT file.
       operationId: getDraftLocalizationKeys
       parameters:
@@ -955,7 +955,7 @@ paths:
           type: string
         style: simple
       - description: A version of the API that should be used for the request. For
-          example, to use version "2020.04", set the value to "application/vnd.dyspatch.2020.04+json"
+          example, to use version "2020.08", set the value to "application/vnd.dyspatch.2020.08+json"
         explode: false
         in: header
         name: Accept
@@ -966,12 +966,12 @@ paths:
       responses:
         "200":
           content:
-            application/vnd.dyspatch.2020.04+json:
+            application/vnd.dyspatch.2020.08+json:
               schema:
                 items:
                   $ref: '#/components/schemas/LocalizationKeyRead'
                 type: array
-            text/vnd.dyspatch.2020.04+x-gettext-translation:
+            text/vnd.dyspatch.2020.08+x-gettext-translation:
               schema:
                 format: binary
                 type: string
@@ -981,7 +981,7 @@ paths:
       summary: Get localization keys
       tags:
       - Drafts
-      x-accepts: application/vnd.dyspatch.2020.04+json,text/vnd.dyspatch.2020.04+x-gettext-translation
+      x-accepts: application/vnd.dyspatch.2020.08+json,text/vnd.dyspatch.2020.08+x-gettext-translation
   /localizations/{localizationId}:
     get:
       description: Returns a specific localization object with a matching ID
@@ -1012,7 +1012,7 @@ paths:
           type: string
         style: form
       - description: A version of the API that should be used for the request. For
-          example, to use version "2020.04", set the value to "application/vnd.dyspatch.2020.04+json"
+          example, to use version "2020.08", set the value to "application/vnd.dyspatch.2020.08+json"
         explode: false
         in: header
         name: Accept
@@ -1023,7 +1023,7 @@ paths:
       responses:
         "200":
           content:
-            application/vnd.dyspatch.2020.04+json:
+            application/vnd.dyspatch.2020.08+json:
               schema:
                 $ref: '#/components/schemas/LocalizationRead'
           description: A localization object with the requested ID
@@ -1130,12 +1130,12 @@ paths:
       summary: Get Localization Object by ID
       tags:
       - Localizations
-      x-accepts: '*/*,application/vnd.dyspatch.2020.04+json'
+      x-accepts: '*/*,application/vnd.dyspatch.2020.08+json'
 components:
   parameters:
     version:
       description: 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"
+        to use version "2020.08", set the value to "application/vnd.dyspatch.2020.08+json"
       explode: false
       in: header
       name: Accept
@@ -1491,6 +1491,7 @@ components:
         compiled:
           sender: Example
           subject: subject
+          ampHtml: ampHtml
           replyTo: Example
           html: html
           text: text
@@ -1553,6 +1554,7 @@ components:
         compiled:
           sender: Example
           subject: subject
+          ampHtml: ampHtml
           replyTo: Example
           html: html
           text: text
@@ -1651,6 +1653,7 @@ components:
         compiled:
           sender: Example
           subject: subject
+          ampHtml: ampHtml
           replyTo: Example
           html: html
           text: text
@@ -1808,6 +1811,7 @@ components:
       example:
         sender: Example
         subject: subject
+        ampHtml: ampHtml
         replyTo: Example
         html: html
         text: text
@@ -1828,6 +1832,10 @@ components:
           description: Base64 encoded template HTML body
           format: byte
           type: string
+        ampHtml:
+          description: Base64 encoded amp version of template body
+          format: byte
+          type: string
         text:
           description: Base64 encoded template text body
           format: byte
@@ -1855,7 +1863,7 @@ components:
         curl --request GET \
         --url https://api.dyspatch.io/templates \
         --header 'Authorization: Bearer EXAMPLEAPIKEYXXXXXXXX12345678' \
-        --header 'Accept: application/vnd.dyspatch.2020.04+json'
+        --header 'Accept: application/vnd.dyspatch.2020.08+json'
         ```
       in: header
       name: Authorization

diff --git a/docs/CompiledRead.md b/docs/CompiledRead.md
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
 **replyTo** | **String** | Reply-To address |  [optional]
 **subject** | **byte[]** | Base64 encoded template subject line |  [optional]
 **html** | **byte[]** | Base64 encoded template HTML body |  [optional]
+**ampHtml** | **byte[]** | Base64 encoded amp version of template body |  [optional]
 **text** | **byte[]** | Base64 encoded template text body |  [optional]