Merge pull request #86 from ConvertKit/v4-api-email-templates

v4 API: Email Templates

Author: n7studios

src/ConvertKit_API.php

@@ -839,6 +839,44 @@ public function get_tag_subscriptions(
         );
     }
 
+    /**
+     * List email templates.
+     *
+     * @param boolean $include_total_count To include the total count of records in the response, use true.
+     * @param string  $after_cursor        Return results after the given pagination cursor.
+     * @param string  $before_cursor       Return results before the given pagination cursor.
+     * @param integer $per_page            Number of results to return.
+     *
+     * @since 2.0.0
+     *
+     * @see https://developers.convertkit.com/v4.html#convertkit-api-email-templates
+     *
+     * @return false|mixed
+     */
+    public function get_email_templates(
+        bool $include_total_count = false,
+        string $after_cursor = '',
+        string $before_cursor = '',
+        int $per_page = 100
+    ) {
+        // Build parameters.
+        $options = ['include_total_count' => $include_total_count];
+
+        // Build pagination parameters.
+        $options = $this->build_pagination_params(
+            params: $options,
+            after_cursor: $after_cursor,
+            before_cursor: $before_cursor,
+            per_page: $per_page
+        );
+
+        // Send request.
+        return $this->get(
+            endpoint: 'email_templates',
+            args: $options
+        );
+    }
+
     /**
      * Gets a resource index
      * Possible resources: forms, landing_pages, subscription_forms, tags

tests/ConvertKitAPITest.php

@@ -3281,6 +3281,105 @@ public function testGetSubscriberTagsPagination()
         $this->assertCount(1, $result->tags);
     }
 
+    /**
+     * Test that get_email_templates() returns the expected data.
+     *
+     * @since   2.0.0
+     *
+     * @return void
+     */
+    public function testGetEmailTemplates()
+    {
+        $result = $this->api->get_email_templates();
+
+        // Assert email templates and pagination exist.
+        $this->assertDataExists($result, 'email_templates');
+        $this->assertPaginationExists($result);
+    }
+
+    /**
+     * Test that get_email_templates() returns the expected data
+     * when the total count is included.
+     *
+     * @since   1.0.0
+     *
+     * @return void
+     */
+    public function testGetEmailTemplatesWithTotalCount()
+    {
+        $result = $this->api->get_email_templates(
+            include_total_count: true
+        );
+
+        // Assert email templates and pagination exist.
+        $this->assertDataExists($result, 'email_templates');
+        $this->assertPaginationExists($result);
+
+        // Assert total count is included.
+        $this->assertArrayHasKey('total_count', get_object_vars($result->pagination));
+        $this->assertGreaterThan(0, $result->pagination->total_count);
+    }
+
+    /**
+     * Test that get_email_templates() returns the expected data
+     * when pagination parameters and per_page limits are specified.
+     *
+     * @since   2.0.0
+     *
+     * @return void
+     */
+    public function testGetEmailTemplatesPagination()
+    {
+        $result = $this->api->get_email_templates(
+            per_page: 1
+        );
+
+        // Assert email templates and pagination exist.
+        $this->assertDataExists($result, 'email_templates');
+        $this->assertPaginationExists($result);
+
+        // Assert a single email template was returned.
+        $this->assertCount(1, $result->email_templates);
+
+        // Assert has_previous_page and has_next_page are correct.
+        $this->assertFalse($result->pagination->has_previous_page);
+        $this->assertTrue($result->pagination->has_next_page);
+
+        // Use pagination to fetch next page.
+        $result = $this->api->get_email_templates(
+            per_page: 1,
+            after_cursor: $result->pagination->end_cursor
+        );
+
+        // Assert email templates and pagination exist.
+        $this->assertDataExists($result, 'email_templates');
+        $this->assertPaginationExists($result);
+
+        // Assert a single email template was returned.
+        $this->assertCount(1, $result->email_templates);
+
+        // Assert has_previous_page and has_next_page are correct.
+        $this->assertTrue($result->pagination->has_previous_page);
+        $this->assertTrue($result->pagination->has_next_page);
+
+        // Use pagination to fetch previous page.
+        $result = $this->api->get_email_templates(
+            per_page: 1,
+            before_cursor: $result->pagination->start_cursor
+        );
+
+        // Assert email templates and pagination exist.
+        $this->assertDataExists($result, 'email_templates');
+        $this->assertPaginationExists($result);
+
+        // Assert a single email template was returned.
+        $this->assertCount(1, $result->email_templates);
+
+        // Assert has_previous_page and has_next_page are correct.
+        $this->assertFalse($result->pagination->has_previous_page);
+        $this->assertTrue($result->pagination->has_next_page);
+    }
+
     /**
      * Test that create_broadcast(), update_broadcast() and destroy_broadcast() works
      * when specifying valid published_at and send_at values.