Remove status_code, as response object includes it

Author: n7studios

README.md

@@ -114,6 +114,26 @@ $api = new \ConvertKit_API\ConvertKit_API(
 );
 ```
 
+API requests may then be performed:
+
+```php
+$result = $api->add_subscriber_to_form(12345, '[email protected]');
+```
+
+To determine whether a new entity / relationship was created, or an existing entity / relationship updated, inspect the HTTP code of the last request:
+
+```php
+$result = $api->add_subscriber_to_form(12345, '[email protected]');
+$code = $api->getResponseInterface()->getStatusCode(); // 200 OK if e.g. a subscriber already added to the specified form, 201 Created if the subscriber added to the specified form for the first time.
+```
+
+The PSR-7 response can be fetched and further inspected, if required - for example, to check if a header exists:
+
+```php
+$result = $api->add_subscriber_to_form(12345, '[email protected]');
+$api->getResponseInterface()->hasHeader('Content-Length'); // Check if the last API request included a `Content-Length` header
+```
+
 ### 1.x (v3 API, API Key and Secret, PHP 7.4+)
 
 Get your ConvertKit API Key and API Secret [here](https://app.convertkit.com/account/edit) and set it somewhere in your application.

src/ConvertKit_API.php

@@ -102,13 +102,6 @@ class ConvertKit_API
      */
     protected $response;
 
-    /**
-     * Guzzle Http Status Code
-     *
-     * @var integer
-     */
-    protected $status_code = 0;
-
 
     /**
      * Constructor for ConvertKitAPI instance
@@ -1655,13 +1648,12 @@ public function make_request(string $endpoint, string $method, array $args = [])
             ['exceptions' => false]
         );
 
-        // Inspect response.
-        $this->status_code = $this->response->getStatusCode();
-        $response_body     = $this->response->getBody()->getContents();
+        // Get response.
+        $response_body = $this->response->getBody()->getContents();
 
         // Log response.
         $this->create_log(sprintf('Response Status Code: %s', $this->response->getStatusCode()));
-        $this->create_log(sprintf('Response Body: %s', $this->response->getBody()->getContents()));
+        $this->create_log(sprintf('Response Body: %s', $response_body));
         $this->create_log('Finish request successfully');
 
         // Return response.
@@ -1675,20 +1667,8 @@ public function make_request(string $endpoint, string $method, array $args = [])
      *
      * @return \Psr\Http\Message\ResponseInterface
      */
-    public function get_response_interface()
+    public function getResponseInterface()
     {
         return $this->response;
     }
-
-    /**
-     * Returns the HTTP status code for the last successful API request.
-     *
-     * @since 2.0.0
-     *
-     * @return integer
-     */
-    public function get_response_status_code()
-    {
-        return $this->status_code;
-    }
 }

tests/ConvertKitAPITest.php

@@ -224,7 +224,7 @@ public function testDebugDisabled()
     }
 
     /**
-     * Test that a Response instance is returned when calling get_response_interface()
+     * Test that a Response instance is returned when calling getResponseInterface()
      * after making an API request.
      *
      * @since   2.0.0
@@ -234,32 +234,16 @@ public function testDebugDisabled()
     public function testGetResponseInterface()
     {
         // Assert response interface is null, as no API request made.
-        $this->assertNull($this->api->get_response_interface());
+        $this->assertNull($this->api->getResponseInterface());
 
         // Perform an API request.
         $result = $this->api->get_account();
 
         // Assert response interface is of a valid type.
-        $this->assertInstanceOf(Response::class, $this->api->get_response_interface());
-    }
-
-    /**
-     * Test that the get_response_status_code() returns the expected HTTP status code.
-     *
-     * @since   2.0.0
-     *
-     * @return  void
-     */
-    public function testGetResponseStatusCode()
-    {
-        // Assert no status code has yet been set in get_response_status_code, as no API request made.
-        $this->assertEquals(0, $this->api->get_response_status_code());
-
-        // Perform an API request.
-        $result = $this->api->get_account();
+        $this->assertInstanceOf(Response::class, $this->api->getResponseInterface());
 
-        // Assert the correct status code defined in get_response_status_code()
-        $this->assertEquals(200, $this->api->get_response_status_code());
+        // Assert the correct status code was returned.
+        $this->assertEquals(200, $this->api->getResponseInterface()->getStatusCode());
     }
 
     /**