Update method and tests

Author: n7studios

src/ConvertKit_API_Traits.php

@@ -225,8 +225,7 @@ public function get_landing_pages(
     /**
      * Adds subscribers to forms in bulk.
      *
-     * @param array<array<string,int>> $forms_subscribers_ids Array of arrays comprising of `form_id` and `subscriber_id`.
-     * @param string                   $referrer              Referrer URL.
+     * @param array<array<string,int>> $forms_subscribers_ids Array of arrays comprising of `form_id`, `subscriber_id` and optional `referrer` URL.
      * @param string                   $callback_url          URL to notify for large batch size when async processing complete.
      *
      * @since 2.1.0
@@ -235,15 +234,10 @@ public function get_landing_pages(
      *
      * @return false|object
      */
-    public function add_subscribers_to_forms(array $forms_subscribers_ids, string $referrer = '', string $callback_url = '')
+    public function add_subscribers_to_forms(array $forms_subscribers_ids, string $callback_url = '')
     {
         // Build parameters.
-        $options = [
-            'additions' => $forms_subscribers_ids,
-        ];
-        if (!empty($referrer)) {
-            $options['referrer'] = $referrer;
-        }
+        $options = ['additions' => $forms_subscribers_ids];
         if (!empty($callback_url)) {
             $options['callback_url'] = $callback_url;
         }

tests/ConvertKitAPITest.php

@@ -2763,13 +2763,14 @@ public function testAddSubscribersToFormsWithReferrer()
                 [
                     'form_id' => (int) $_ENV['CONVERTKIT_API_FORM_ID'],
                     'subscriber_id' => $subscriber->subscriber->id,
+                    'referrer' => 'https://mywebsite.com/bfpromo/',
                 ],
                 [
                     'form_id' => (int) $_ENV['CONVERTKIT_API_FORM_ID_2'],
                     'subscriber_id' => $subscriber->subscriber->id,
+                    'referrer' => 'https://mywebsite.com/bfpromo/',
                 ],
-            ],
-            referrer: 'https://mywebsite.com/bfpromo/'
+            ]
         );
 
         // Assert no failures.
@@ -2779,11 +2780,11 @@ public function testAddSubscribersToFormsWithReferrer()
         $this->assertIsArray($result->subscribers);
 
         // Assert referrer data set for subscribers.
-        foreach($result->subscribers as $subscriber) {
+        foreach ($result->subscribers as $subscriber) {
              $this->assertEquals(
-                $subscriber->referrer,
-                'https://mywebsite.com/bfpromo/'
-            );
+                 $subscriber->referrer,
+                 'https://mywebsite.com/bfpromo/'
+             );
         }
     }
 
@@ -2822,13 +2823,14 @@ public function testAddSubscribersToFormsWithReferrerUTMParams()
                 [
                     'form_id' => (int) $_ENV['CONVERTKIT_API_FORM_ID'],
                     'subscriber_id' => $subscriber->subscriber->id,
+                    'referrer' => $referrer,
                 ],
                 [
                     'form_id' => (int) $_ENV['CONVERTKIT_API_FORM_ID_2'],
                     'subscriber_id' => $subscriber->subscriber->id,
+                    'referrer' => $referrer,
                 ],
-            ],
-            referrer: $referer
+            ]
         );
 
         // Assert no failures.
@@ -2838,10 +2840,10 @@ public function testAddSubscribersToFormsWithReferrerUTMParams()
         $this->assertIsArray($result->subscribers);
 
         // Assert referrer data set for subscribers.
-        foreach($result->subscribers as $subscriber) {
+        foreach ($result->subscribers as $subscriber) {
             $this->assertEquals(
                 $subscriber->referrer,
-                $referer
+                $referrer
             );
             $this->assertEquals(
                 $subscriber->referrer_utm_parameters->source,
@@ -2901,7 +2903,7 @@ public function testAddSubscribersToFormsWithInvalidFormIDs()
 
         // Assert failures.
         $this->assertCount(2, $result->failures);
-        foreach($result->failures as $failure) {
+        foreach ($result->failures as $failure) {
             $this->assertEquals(
                 $failure->errors[0],
                 'Form does not exist'
@@ -2944,7 +2946,7 @@ public function testAddSubscribersToFormsWithInvalidSubscriberIDs()
 
         // Assert failures.
         $this->assertCount(2, $result->failures);
-        foreach($result->failures as $failure) {
+        foreach ($result->failures as $failure) {
             $this->assertEquals(
                 $failure->errors[0],
                 'Subscriber does not exist'