feat: added a simple HttpResponse object to 'wrap' the response

features/support/api.ts

@@ -138,30 +138,30 @@ export class ModelSteps extends BaseModelStep {
 
   @then(/the response should be of type (.*)/)
   public checkResponseType(type: string) {
-    assert.equal(this.apiResponse.constructor.name, type);
+    assert.equal(this.apiResponse.data.constructor.name, type);
   }
 
   @then(/the response should be equal to "(.*)"/)
   public checkResponseValue(value: string) {
-    assert.equal(this.apiResponse, value);
+    assert.equal(this.apiResponse.data, value);
   }
 
   @then(/the response should have a property ([a-zA-Z]*) with value (.*)/)
   public checkResponseProperty(propName: string, propValue: string) {
-    const value = this.apiResponse[propName];
+    const value = this.apiResponse.data[propName];
     const formattedValue =
       value instanceof Date ? value.toISOString() : value.toString();
     assert.equal(formattedValue, propValue);
   }
 
   @then(/the response should be an array/)
   public checkArrayResponse() {
-    assert.isArray(this.apiResponse);
+    assert.isArray(this.apiResponse.data);
   }
 
   @when(/extracting the object at index ([0-9]*)/)
   public extractAtIndex(index: string) {
-    this.apiResponse = this.apiResponse[parseInt(index)];
+    this.apiResponse.data = this.apiResponse.data[parseInt(index)];
   }
 
   @then(/the request method should be of type (.*)/)

template/api.ts.handlebars

@@ -2,6 +2,7 @@ import Configuration from "./configuration";
 {{>modelIncludes models=components.schemas options=_options}}
 {{>modelIncludes models=components.inlineObjects options=_options}}
 import { request } from "./request";
+import { HttpResponse } from "./response";
 import { Parameter, ParameterBuilder } from "./parameterBuilder";
 import { deserialize, serialize } from "./serializer";
 
@@ -43,7 +44,7 @@ export default class Api{{_tag.name}} {
           {{typeConvert schema ../../../_options}}
           {{#if schema.default}} = {{{quoteIfString schema.default}}}{{/if}},
         {{/each}}
-      ): Promise<{{#if _response.schema}}{{typeConvert _response.schema ../../_options}}{{else}}null{{/if}}> {
+      ): Promise<{{#if _response.schema}}HttpResponse<{{typeConvert _response.schema ../../_options}}>{{else}}null{{/if}}> {
 
         const builder = new ParameterBuilder();
         {{#each _sortedParameters}}{{#unless _optional}}
@@ -58,7 +59,9 @@ export default class Api{{_tag.name}} {
 
         const response = await request(this.config, "{{@root.path}}", "{{@key}}", builder.parameters);
         {{#if _response.schema}}
-        return deserialize(response, "{{typeConvert _response.schema}}");
+        return {
+          data: deserialize(response, "{{typeConvert _response.schema}}")
+        };
         {{else}}
         return null;
         {{/if}}

template/response.ts

@@ -0,0 +1,6 @@
+/**
+ * The response of a HTTP request, contains both the response data and associated metadata.
+ */
+export interface HttpResponse<T> {
+  data: T;
+}