feat(api): cross-client previews endpoints

.stats.yml

@@ -1 +1 @@
-configured_endpoints: 158
+configured_endpoints: 167

build.gradle.kts

@@ -8,7 +8,7 @@ repositories {
 
 allprojects {
     group = "com.courier"
-    version = "6.10.0" // x-release-please-version
+    version = "6.9.0" // x-release-please-version
 }
 
 subprojects {

courier-java-core/src/main/kotlin/com/courier/client/CourierClient.kt

@@ -16,6 +16,7 @@ import com.courier.services.blocking.JourneyService
 import com.courier.services.blocking.ListService
 import com.courier.services.blocking.MessageService
 import com.courier.services.blocking.NotificationService
+import com.courier.services.blocking.PreviewService
 import com.courier.services.blocking.ProfileService
 import com.courier.services.blocking.ProviderService
 import com.courier.services.blocking.RequestService
@@ -103,6 +104,12 @@ interface CourierClient {
      */
     fun broadcasts(): BroadcastService
 
+    /**
+     * Render a template's email content on real email clients and read back the screenshots, so you
+     * can check how it looks before you send it.
+     */
+    fun previews(): PreviewService
+
     fun bulk(): BulkService
 
     /** Manage the logos, colors, and layout that give the templates you send a consistent look. */
@@ -229,6 +236,12 @@ interface CourierClient {
          */
         fun broadcasts(): BroadcastService.WithRawResponse
 
+        /**
+         * Render a template's email content on real email clients and read back the screenshots, so
+         * you can check how it looks before you send it.
+         */
+        fun previews(): PreviewService.WithRawResponse
+
         fun bulk(): BulkService.WithRawResponse
 
         /**

courier-java-core/src/main/kotlin/com/courier/client/CourierClientAsync.kt

@@ -16,6 +16,7 @@ import com.courier.services.async.JourneyServiceAsync
 import com.courier.services.async.ListServiceAsync
 import com.courier.services.async.MessageServiceAsync
 import com.courier.services.async.NotificationServiceAsync
+import com.courier.services.async.PreviewServiceAsync
 import com.courier.services.async.ProfileServiceAsync
 import com.courier.services.async.ProviderServiceAsync
 import com.courier.services.async.RequestServiceAsync
@@ -103,6 +104,12 @@ interface CourierClientAsync {
      */
     fun broadcasts(): BroadcastServiceAsync
 
+    /**
+     * Render a template's email content on real email clients and read back the screenshots, so you
+     * can check how it looks before you send it.
+     */
+    fun previews(): PreviewServiceAsync
+
     fun bulk(): BulkServiceAsync
 
     /** Manage the logos, colors, and layout that give the templates you send a consistent look. */
@@ -233,6 +240,12 @@ interface CourierClientAsync {
          */
         fun broadcasts(): BroadcastServiceAsync.WithRawResponse
 
+        /**
+         * Render a template's email content on real email clients and read back the screenshots, so
+         * you can check how it looks before you send it.
+         */
+        fun previews(): PreviewServiceAsync.WithRawResponse
+
         fun bulk(): BulkServiceAsync.WithRawResponse
 
         /**

courier-java-core/src/main/kotlin/com/courier/client/CourierClientAsyncImpl.kt

@@ -30,6 +30,8 @@ import com.courier.services.async.MessageServiceAsync
 import com.courier.services.async.MessageServiceAsyncImpl
 import com.courier.services.async.NotificationServiceAsync
 import com.courier.services.async.NotificationServiceAsyncImpl
+import com.courier.services.async.PreviewServiceAsync
+import com.courier.services.async.PreviewServiceAsyncImpl
 import com.courier.services.async.ProfileServiceAsync
 import com.courier.services.async.ProfileServiceAsyncImpl
 import com.courier.services.async.ProviderServiceAsync
@@ -95,6 +97,10 @@ class CourierClientAsyncImpl(private val clientOptions: ClientOptions) : Courier
         BroadcastServiceAsyncImpl(clientOptionsWithUserAgent)
     }
 
+    private val previews: PreviewServiceAsync by lazy {
+        PreviewServiceAsyncImpl(clientOptionsWithUserAgent)
+    }
+
     private val bulk: BulkServiceAsync by lazy { BulkServiceAsyncImpl(clientOptionsWithUserAgent) }
 
     private val brands: BrandServiceAsync by lazy {
@@ -192,6 +198,12 @@ class CourierClientAsyncImpl(private val clientOptions: ClientOptions) : Courier
      */
     override fun broadcasts(): BroadcastServiceAsync = broadcasts
 
+    /**
+     * Render a template's email content on real email clients and read back the screenshots, so you
+     * can check how it looks before you send it.
+     */
+    override fun previews(): PreviewServiceAsync = previews
+
     override fun bulk(): BulkServiceAsync = bulk
 
     /** Manage the logos, colors, and layout that give the templates you send a consistent look. */
@@ -290,6 +302,10 @@ class CourierClientAsyncImpl(private val clientOptions: ClientOptions) : Courier
             BroadcastServiceAsyncImpl.WithRawResponseImpl(clientOptions)
         }
 
+        private val previews: PreviewServiceAsync.WithRawResponse by lazy {
+            PreviewServiceAsyncImpl.WithRawResponseImpl(clientOptions)
+        }
+
         private val bulk: BulkServiceAsync.WithRawResponse by lazy {
             BulkServiceAsyncImpl.WithRawResponseImpl(clientOptions)
         }
@@ -395,6 +411,12 @@ class CourierClientAsyncImpl(private val clientOptions: ClientOptions) : Courier
          */
         override fun broadcasts(): BroadcastServiceAsync.WithRawResponse = broadcasts
 
+        /**
+         * Render a template's email content on real email clients and read back the screenshots, so
+         * you can check how it looks before you send it.
+         */
+        override fun previews(): PreviewServiceAsync.WithRawResponse = previews
+
         override fun bulk(): BulkServiceAsync.WithRawResponse = bulk
 
         /**

courier-java-core/src/main/kotlin/com/courier/client/CourierClientImpl.kt

@@ -30,6 +30,8 @@ import com.courier.services.blocking.MessageService
 import com.courier.services.blocking.MessageServiceImpl
 import com.courier.services.blocking.NotificationService
 import com.courier.services.blocking.NotificationServiceImpl
+import com.courier.services.blocking.PreviewService
+import com.courier.services.blocking.PreviewServiceImpl
 import com.courier.services.blocking.ProfileService
 import com.courier.services.blocking.ProfileServiceImpl
 import com.courier.services.blocking.ProviderService
@@ -93,6 +95,8 @@ class CourierClientImpl(private val clientOptions: ClientOptions) : CourierClien
         BroadcastServiceImpl(clientOptionsWithUserAgent)
     }
 
+    private val previews: PreviewService by lazy { PreviewServiceImpl(clientOptionsWithUserAgent) }
+
     private val bulk: BulkService by lazy { BulkServiceImpl(clientOptionsWithUserAgent) }
 
     private val brands: BrandService by lazy { BrandServiceImpl(clientOptionsWithUserAgent) }
@@ -176,6 +180,12 @@ class CourierClientImpl(private val clientOptions: ClientOptions) : CourierClien
      */
     override fun broadcasts(): BroadcastService = broadcasts
 
+    /**
+     * Render a template's email content on real email clients and read back the screenshots, so you
+     * can check how it looks before you send it.
+     */
+    override fun previews(): PreviewService = previews
+
     override fun bulk(): BulkService = bulk
 
     /** Manage the logos, colors, and layout that give the templates you send a consistent look. */
@@ -274,6 +284,10 @@ class CourierClientImpl(private val clientOptions: ClientOptions) : CourierClien
             BroadcastServiceImpl.WithRawResponseImpl(clientOptions)
         }
 
+        private val previews: PreviewService.WithRawResponse by lazy {
+            PreviewServiceImpl.WithRawResponseImpl(clientOptions)
+        }
+
         private val bulk: BulkService.WithRawResponse by lazy {
             BulkServiceImpl.WithRawResponseImpl(clientOptions)
         }
@@ -379,6 +393,12 @@ class CourierClientImpl(private val clientOptions: ClientOptions) : CourierClien
          */
         override fun broadcasts(): BroadcastService.WithRawResponse = broadcasts
 
+        /**
+         * Render a template's email content on real email clients and read back the screenshots, so
+         * you can check how it looks before you send it.
+         */
+        override fun previews(): PreviewService.WithRawResponse = previews
+
         override fun bulk(): BulkService.WithRawResponse = bulk
 
         /**