@serenity-js/rest 3.0.0-rc.9 → 3.0.0

package/lib/screenplay/questions/LastResponse.js

@@ -4,63 +4,73 @@ exports.LastResponse = void 0;
 const core_1 = require("@serenity-js/core");
 const abilities_1 = require("../abilities");
 /**
- * @desc
- *  Provides access to the properties of the last {@link AxiosResponse} object,
- *  cached on the {@link CallAnApi} {@link @serenity-js/core/lib/screenplay~Ability}.
+ * Provides access to the properties of the last {@apilink AxiosResponse} object,
+ * cached on the {@apilink Ability|ability} to {@apilink CallAnApi}.
  *
- * @example <caption>Verify response to a GET request</caption>
- *  import { Actor } from '@serenity-js/core';
- *  import { CallAnApi, GetRequest, LastResponse, Send } from '@serenity-js/rest'
- *  import { Ensure, equals } from '@serenity-js/assertions';
+ * ## Verify response to a GET request
  *
- *  interface Book {
- *      title: string;
- *      author: string
- *  }
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core'
+ * import { CallAnApi, GetRequest, LastResponse, Send } from '@serenity-js/rest'
+ * import { Ensure, equals } from '@serenity-js/assertions'
  *
- *  const actor = Actor.named('Apisit').whoCan(CallAnApi.at('https://myapp.com/api'));
+ * interface Book {
+ *     title: string;
+ *     author: string;
+ * }
  *
- *  actor.attemptsTo(
- *      Send.a(GetRequest.to('/books/0-688-00230-7')),
- *      Ensure.that(LastResponse.status(), equals(200)),
- *      Ensure.that(LastResponse.header('Content-Type'), equals('application/json')),
- *      Ensure.that(LastResponse.body<Book>(), equals({
- *          title: 'Zen and the Art of Motorcycle Maintenance: An Inquiry into Values',
- *          author: 'Robert M. Pirsig',
- *      })),
- *  );
+ * await actorCalled('Apisit')
+ *   .whoCan(CallAnApi.at('https://api.example.org/'))
+ *   .attemptsTo(
+ *     Send.a(GetRequest.to('/books/0-688-00230-7')),
+ *     Ensure.that(LastResponse.status(), equals(200)),
+ *     Ensure.that(LastResponse.header('Content-Type'), equals('application/json')),
+ *     Ensure.that(LastResponse.body<Book>(), equals({
+ *         title: 'Zen and the Art of Motorcycle Maintenance: An Inquiry into Values',
+ *         author: 'Robert M. Pirsig',
+ *     })),
+ *   )
+ * ```
  *
- * @example <caption>Use Serenity/JS adapters to navigate complex response objects</caption>
- *  import { Actor } from '@serenity-js/core';
- *  import { CallAnApi, GetRequest, LastResponse, Send } from '@serenity-js/rest'
- *  import { Ensure, equals } from '@serenity-js/assertions';
+ * ## Use Serenity/JS adapters to navigate complex response objects
  *
- *  interface Developer {
- *      name: string;
- *      id: string;
- *      projects: Project[];
- *  }
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core'
+ * import { CallAnApi, GetRequest, LastResponse, Send } from '@serenity-js/rest'
+ * import { Ensure, equals } from '@serenity-js/assertions'
  *
- *  interface Project {
- *      name: string;
- *      repoUrl: string;
- *  }
+ * interface Developer {
+ *     name: string;
+ *     id: string;
+ *     projects: Project[];
+ * }
  *
- *  const actor = Actor.named('Apisit').whoCan(CallAnApi.at('https://myapp.com/api'));
+ * interface Project {
+ *     name: string;
+ *     repoUrl: string;
+ * }
  *
- *  actor.attemptsTo(
- *      Send.a(GetRequest.to('/developers/jan-molak')),
- *      Ensure.that(LastResponse.status(), equals(200)),
- *      Ensure.that(LastResponse.body<Developer>().name, equals('Jan Molak')),
- *      Ensure.that(LastResponse.body<Developer>().projects[0].name, equals('Serenity/JS')),
- *  );
+ * await actorCalled('Apisitt')
+ *   .whoCan(CallAnApi.at('https://api.example.org/'))
+ *   .attemptsTo(
+ *     Send.a(GetRequest.to('/developers/jan-molak')),
+ *     Ensure.that(LastResponse.status(), equals(200)),
+ *     Ensure.that(LastResponse.body<Developer>().name, equals('Jan Molak')),
+ *     Ensure.that(LastResponse.body<Developer>().projects[0].name, equals('Serenity/JS')),
+ * )
+ * ```
+ *
+ * ## Learn more
+ * - [AxiosResponse](https://github.com/axios/axios/blob/v0.27.2/index.d.ts#L133-L140)
+ *
+ * @group Questions
  */
 class LastResponse {
     /**
-     * @desc
-     *  Enables asserting on the {@link LastResponse} status
+     * Retrieves the status code of the {@apilink LastResponse|last response}
      *
-     * @returns {@serenity-js/core/lib/screenplay~Question<number>}
+     * #### Learn more
+     * - [HTTP response status codes](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status)
      */
     static status() {
         return core_1.Question.about(`the status of the last response`, async (actor) => {
@@ -68,60 +78,78 @@ class LastResponse {
         });
     }
     /**
-     * @desc
-     *  Enables asserting on the {@link LastResponse} body
+     * Retrieves the body of the {@apilink LastResponse|last response}
+     *
+     * #### A type-safe approach using generics
      *
-     * @example <caption>A type-safe approach using generics</caption>
-     *  interface Book {
-     *      title: string;
-     *      author: string
-     *  }
+     * ```ts
+     * import { actorCalled } from '@serenity-js/core'
+     * import { CallAnApi, LastResponse } from '@serenity-js/rest'
+     * import { Ensure, equals } from '@serenity-js/assertions'
      *
-     *  actor.attemptsTo(
+     * interface Book {
+     *   title: string;
+     *   author: string;
+     * }
+     *
+     * await actorCalled('Apisitt')
+     *   .whoCan(CallAnApi.at('https://api.example.org/'))
+     *   .attemptsTo(
      *      // ...
+     *
+     *      // note body<T>() parameterised with type "Book"
      *      Ensure.that(LastResponse.body<Book>(), equals({
-     *          title: 'Zen and the Art of Motorcycle Maintenance: An Inquiry into Values',
-     *          author: 'Robert M. Pirsig',
+     *        title: 'Zen and the Art of Motorcycle Maintenance: An Inquiry into Values',
+     *        author: 'Robert M. Pirsig',
      *      })),
-     *  );
+     *   )
+     * ```
      *
-     * @example <caption>A non-type-safe approach using `any`</caption>
-     *  actor.attemptsTo(
+     * ## A not type-safe approach using `any`
+     *
+     * ```ts
+     * import { actorCalled } from '@serenity-js/core'
+     * import { CallAnApi, LastResponse } from '@serenity-js/rest'
+     * import { Ensure, equals } from '@serenity-js/assertions'
+     *
+     * await actorCalled('Apisitt')
+     *   .whoCan(CallAnApi.at('https://api.example.org/'))
+     *   .attemptsTo(
      *      // ...
+     *
+     *      // note body<T>() parameterised with "any" or with no parameter is not type-safe!
      *      Ensure.that(LastResponse.body<any>(), equals({
-     *          title: 'Zen and the Art of Motorcycle Maintenance: An Inquiry into Values',
-     *          author: 'Robert M. Pirsig',
+     *        title: 'Zen and the Art of Motorcycle Maintenance: An Inquiry into Values',
+     *        author: 'Robert M. Pirsig',
      *      })),
-     *  );
-     *
-     * @example <caption>Retrieving an item at path using Property.of</caption>
-     *  import { Property } from '@serenity-js/core';
-     *
-     *  actor.attemptsTo(
-     *      Ensure.that(
-     *          Property.of(LastResponse.body<Book>()).title,
-     *          equals('Zen and the Art of Motorcycle Maintenance: An Inquiry into Values'),
-     *      )
-     *  )
-     *
-     * @example <caption>Filtering response body using List</caption>
-     *  import { Property } from '@serenity-js/core';
-     *  import { property, startsWith } from '@serenity-js/assertions';
-     *
-     *  actor.attemptsTo(
-     *      Ensure.that(
-     *          // imagine the API returns an array of books
-     *          List.of(LastResponse.body<Book[]>())
-     *              .where(Property.at<Book>().author, equals('Robert M. Pirsig'))
-     *              .first(),
-     *          property('title', startsWith('Zen and the Art of Motorcycle Maintenance')),
-     *      )
-     *  )
-     *
-     * @returns {@serenity-js/core/lib/screenplay~Question<any>}
-     *
-     * @see {@link @serenity-js/core/lib/screenplay/questions~Property}
-     * @see {@link @serenity-js/core/lib/screenplay/questions~List}
+     *   )
+     * ```
+     *
+     * ## Iterating over the items in the response body
+     *
+     * ```ts
+     * import { actorCalled } from '@serenity-js/core'
+     * import { CallAnApi, LastResponse } from '@serenity-js/rest'
+     * import { Ensure, equals } from '@serenity-js/assertions'
+     *
+     * interface Product {
+     *   id: number;
+     *   name: string;
+     * }
+     *
+     * await actorCalled('Apisitt')
+     *   .whoCan(CallAnApi.at('https://api.example.org/'))
+     *   .attemptsTo(
+     *     Send.a(GetRequest.to(`/products`)),
+     *     List.of<Product>(LastResponse.body<{ products: Product[] }>().products)
+     *       .forEach(({ item, actor }) =>
+     *         actor.attemptsTo(
+     *           Send.a(GetRequest.to(`/products/${ item.id }`)),
+     *           Ensure.that(LastResponse.body<Product>().id, equals(item.id)),
+     *         )
+     *       ),
+     *   )
+     * ```
      */
     static body() {
         return core_1.Question.about(`the body of the last response`, async (actor) => {
@@ -129,11 +157,24 @@ class LastResponse {
         });
     }
     /**
-     * @desc
-     *  Enables asserting on one of the {@link LastResponse}'s headers
+     * Retrieves a header of the {@apilink LastResponse|last response}, identified by `name`
+     *
+     * ## Asserting on a header
      *
-     * @param {string} name
-     * @returns {@serenity-js/core/lib/screenplay~Question<string>}
+     * ```ts
+     * import { actorCalled } from '@serenity-js/core'
+     * import { CallAnApi, LastResponse } from '@serenity-js/rest'
+     * import { Ensure, equals } from '@serenity-js/assertions'
+     *
+     * await actorCalled('Apisitt')
+     *   .whoCan(CallAnApi.at('https://api.example.org/'))
+     *   .attemptsTo(
+     *     Send.a(GetRequest.to(`/products`)),
+     *     Ensure.that(LastResponse.header('Content-Type'), equals('application/json')),
+     *   )
+     * ```
+     *
+     * @param name
      */
     static header(name) {
         return core_1.Question.about(`the '${name}' header of the last response`, async (actor) => {
@@ -141,11 +182,22 @@ class LastResponse {
         });
     }
     /**
-     * @desc
-     *  Enables asserting on all of the {@link LastResponse}'s headers,
-     *  returned as an object where the keys represent header names.
+     * Retrieves all the headers of the {@apilink LastResponse|last response}.
+     *
+     * ## Asserting on a header
+     *
+     * ```ts
+     * import { actorCalled } from '@serenity-js/core'
+     * import { CallAnApi, LastResponse } from '@serenity-js/rest'
+     * import { Ensure, equals } from '@serenity-js/assertions'
      *
-     * @returns {@serenity-js/core/lib/screenplay~Question<Record<string, string>>}
+     * await actorCalled('Apisitt')
+     *   .whoCan(CallAnApi.at('https://api.example.org/'))
+     *   .attemptsTo(
+     *     Send.a(GetRequest.to(`/products`)),
+     *     Ensure.that(LastResponse.headers()['Content-Type'], equals('application/json')),
+     *   )
+     * ```
      */
     static headers() {
         return core_1.Question.about(`the headers or the last response`, async (actor) => {

package/lib/screenplay/questions/LastResponse.js.map

@@ -1 +1 @@
-{"version":3,"file":"LastResponse.js","sourceRoot":"","sources":["../../../src/screenplay/questions/LastResponse.ts"],"names":[],"mappings":";;;AAAA,4CAA8D;AAE9D,4CAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;AACH,MAAa,YAAY;IAErB;;;;;OAKG;IACH,MAAM,CAAC,MAAM;QACT,OAAO,eAAQ,CAAC,KAAK,CAAS,iCAAiC,EAAE,KAAK,EAAC,KAAK,EAAC,EAAE;YAC3E,OAAO,qBAAS,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAC5E,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuDG;IACH,MAAM,CAAC,IAAI;QACP,OAAO,eAAQ,CAAC,KAAK,CAAI,+BAA+B,EAAE,KAAK,EAAC,KAAK,EAAC,EAAE;YACpE,OAAO,qBAAS,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,eAAe,CAAI,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,IAAS,CAAC,CAAC;QAClF,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,MAAM,CAAC,IAAY;QACtB,OAAO,eAAQ,CAAC,KAAK,CAAS,QAAS,IAAK,+BAA+B,EAAE,KAAK,EAAC,KAAK,EAAC,EAAE;YACvF,OAAO,qBAAS,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;QACnF,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,OAAO;QACV,OAAO,eAAQ,CAAC,KAAK,CAAyB,kCAAkC,EAAE,KAAK,EAAC,KAAK,EAAC,EAAE;YAC5F,OAAO,qBAAS,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAC7E,CAAC,CAAC,CAAC;IACP,CAAC;CACJ;AArGD,oCAqGC"}
+{"version":3,"file":"LastResponse.js","sourceRoot":"","sources":["../../../src/screenplay/questions/LastResponse.ts"],"names":[],"mappings":";;;AAAA,4CAA8D;AAG9D,4CAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6DG;AACH,MAAa,YAAY;IAErB;;;;;OAKG;IACH,MAAM,CAAC,MAAM;QACT,OAAO,eAAQ,CAAC,KAAK,CAAS,iCAAiC,EAAE,KAAK,EAAC,KAAK,EAAC,EAAE;YAC3E,OAAO,qBAAS,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAC5E,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyEG;IACH,MAAM,CAAC,IAAI;QACP,OAAO,eAAQ,CAAC,KAAK,CAAI,+BAA+B,EAAE,KAAK,EAAC,KAAK,EAAC,EAAE;YACpE,OAAO,qBAAS,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,eAAe,CAAI,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,IAAS,CAAC,CAAC;QAClF,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,MAAM,CAAC,IAAY;QACtB,OAAO,eAAQ,CAAC,KAAK,CAAS,QAAS,IAAK,+BAA+B,EAAE,KAAK,EAAC,KAAK,EAAC,EAAE;YACvF,OAAO,qBAAS,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;QACnF,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,OAAO;QACV,OAAO,eAAQ,CAAC,KAAK,CAA0B,kCAAkC,EAAE,KAAK,EAAC,KAAK,EAAC,EAAE;YAC7F,OAAO,qBAAS,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,OAAkC,CAAC,CAAC;QACxG,CAAC,CAAC,CAAC;IACP,CAAC;CACJ;AA/ID,oCA+IC"}

package/lib/screenplay/questions/index.d.ts

@@ -1 +1,2 @@
 export * from './LastResponse';
+//# sourceMappingURL=index.d.ts.map

package/lib/screenplay/questions/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/screenplay/questions/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC"}

package/lib/screenplay/questions/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/lib/screenplay/questions/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/screenplay/questions/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,iDAA+B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/screenplay/questions/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,iDAA+B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serenity-js/rest",
-  "version": "3.0.0-rc.9",
+  "version": "3.0.0",
   "description": "Test REST APIs with Serenity/JS",
   "author": {
     "name": "Jan Molak",
@@ -28,60 +28,37 @@
     "testing"
   ],
   "scripts": {
-    "clean": "rimraf .nyc_output lib target",
-    "lint": "eslint --ext ts --config ../../.eslintrc.yml .",
-    "lint:fix": "npm run lint -- --fix",
-    "test": "nyc --report-dir ../../target/coverage/rest mocha --config ../../.mocharc.yml 'spec/**/*.spec.*'",
-    "compile": "tsc --project tsconfig.json",
-    "site": "esdoc -c .esdoc.js"
+    "clean": "rimraf target",
+    "test": "nyc mocha --config ../../.mocharc.yml 'spec/**/*.spec.*'",
+    "compile": "rimraf lib && tsc --project tsconfig.build.json"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/serenity-js/serenity-js.git"
+    "url": "https://github.com/serenity-js/serenity-js.git",
+    "directory": "packages/rest"
   },
   "bugs": {
     "url": "https://github.com/serenity-js/serenity-js/issues"
   },
   "engines": {
-    "node": "^14 || ^16",
-    "npm": "^6 || ^7 || ^8"
+    "node": "^14 || ^16 || ^18",
+    "npm": "^6 || ^7 || ^8 || ^9"
   },
   "dependencies": {
-    "@serenity-js/core": "3.0.0-rc.9",
-    "axios": "^0.21.4"
+    "@serenity-js/core": "3.0.0",
+    "axios": "^1.3.4"
   },
   "devDependencies": {
-    "@documentation/esdoc-template": "3.0.0",
     "@integration/testing-tools": "3.0.0",
-    "@serenity-js/assertions": "3.0.0-rc.9",
-    "@types/chai": "^4.3.0",
-    "@types/mocha": "^9.0.0",
-    "axios-mock-adapter": "^1.20.0",
-    "mocha": "^9.1.3",
-    "ts-node": "^10.4.0",
-    "typescript": "^4.5.4"
+    "@serenity-js/assertions": "3.0.0",
+    "@types/chai": "^4.3.4",
+    "@types/mocha": "^10.0.1",
+    "axios-mock-adapter": "^1.21.2",
+    "mocha": "^10.2.0",
+    "mocha-multi": "^1.1.7",
+    "nyc": "15.1.0",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.9.5"
   },
-  "nyc": {
-    "include": [
-      "src/**/*.ts"
-    ],
-    "exclude": [
-      "src/**/*.d.ts",
-      "lib",
-      "node_modules",
-      "spec"
-    ],
-    "extension": [
-      ".ts"
-    ],
-    "require": [
-      "ts-node/register"
-    ],
-    "reporter": [
-      "json"
-    ],
-    "cache": true,
-    "all": true
-  },
-  "gitHead": "bc72fce0831fe6c1e4e69d5ca307d7fb5f6d2f0d"
+  "gitHead": "1c2fffcabd725822e6c93fb4125f5830fa97f56d"
 }

package/src/index.ts

@@ -1,2 +1,2 @@
-export * from './model';
+export * from './models';
 export * from './screenplay';

package/src/models/DeleteRequest.ts

@@ -0,0 +1,73 @@
+import { Answerable, Question, WithAnswerableProperties } from '@serenity-js/core';
+import { AxiosRequestConfig } from 'axios';
+
+import { HTTPRequest } from './HTTPRequest';
+
+/**
+ * The DELETE method requests that the origin server remove the
+ * association between the target resource and its current
+ * functionality.
+ *
+ * ## Create and then remove a resource
+ *
+ * ```ts
+ *  import { actorCalled } from '@serenity-js/core'
+ *  import { CallAnApi, DeleteRequest, LastResponse, PostRequest, Send } from '@serenity-js/rest'
+ *  import { Ensure, equals, startsWith } from '@serenity-js/assertions'
+ *
+ *  await actorCalled('Apisitt')
+ *    .whoCan(CallAnApi.at('https://api.example.org/'))
+ *    .attemptsTo(
+ *      // create a new test user account
+ *      Send.a(PostRequest.to('/users').with({
+ *          login: 'tester',
+ *          password: 'P@ssword1',
+ *      }),
+ *      Ensure.that(LastResponse.status(), equals(201)),
+ *      Ensure.that(LastResponse.header('Location'), startsWith('/users')),
+ *
+ *      // delete the test user account
+ *      Send.a(DeleteRequest.to(LastResponse.header('Location'))),
+ *      Ensure.that(LastResponse.status(), equals(200)),
+ *    )
+ * ```
+ *
+ * ## Learn more
+ * - https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/DELETE
+ * - https://tools.ietf.org/html/rfc7231#section-4.3.5
+ *
+ * @group Models
+ */
+export class DeleteRequest extends HTTPRequest {
+
+    /**
+     * Configures the object with a destination URI.
+     *
+     * When the `resourceUri` is not a fully qualified URL but a path, such as `/products/2`,
+     * it gets concatenated with the URL provided to the Axios instance
+     * when the {@apilink Ability|ability} to {@apilink CallAnApi} was instantiated.
+     *
+     * @param resourceUri
+     *  The URI where the {@apilink Actor}
+     *  should send the {@apilink HTTPRequest}
+     */
+    static to(resourceUri: Answerable<string>): DeleteRequest {
+        return new DeleteRequest(resourceUri);
+    }
+
+    /**
+     * Overrides the default Axios request configuration provided
+     * when the {@apilink Ability|ability} to {@apilink CallAnApi} was instantiated.
+     *
+     * #### Learn more
+     * - {@apilink Answerable}
+     * - {@apilink WithAnswerableProperties}
+     * - [AxiosRequestConfig](https://github.com/axios/axios/blob/v0.27.2/index.d.ts#L75-L113)
+     *
+     * @param {Answerable<WithAnswerableProperties<AxiosRequestConfig>>} config
+     *  Axios request configuration overrides
+     */
+    using(config: Answerable<WithAnswerableProperties<AxiosRequestConfig>>): DeleteRequest {
+        return new DeleteRequest(this.resourceUri, undefined, Question.fromObject(config));
+    }
+}

package/src/models/GetRequest.ts

@@ -0,0 +1,80 @@
+import { Answerable, Question, WithAnswerableProperties } from '@serenity-js/core';
+import { AxiosRequestConfig } from 'axios';
+
+import { HTTPRequest } from './HTTPRequest';
+
+/**
+ * The HTTP GET method requests a representation of the specified resource.
+ * It is the most frequent type of request made by consumers of a typical HTTP API.
+ * For this reason it's important to test every known endpoint that responds to GET requests and ensure that it
+ * behaves correctly.
+ *
+ * Since the GET method is used to _retrieve_ data from a server, it should be implemented
+ * as [safe](https://developer.mozilla.org/en-US/docs/Glossary/Safe)
+ * and [idempotent](https://developer.mozilla.org/en-US/docs/Glossary/Idempotent).
+ * This means that an identical request can be made once or several times in a row with the same effect while leaving
+ * the server in the same state.
+ *
+ * ## Verify response to a GET request
+ *
+ * ```ts
+ *  import { actorCalled } from '@serenity-js/core'
+ *  import { CallAnApi, GetRequest, LastResponse, Send } from '@serenity-js/rest'
+ *  import { Ensure, equals } from '@serenity-js/assertions'
+ *
+ *  interface Book {
+ *      title: string;
+ *      author: string;
+ *  }
+ *
+ *  await actorCalled('Apisitt')
+ *    .whoCan(CallAnApi.at('https://api.example.org/'))
+ *    .attemptsTo(
+ *      Send.a(GetRequest.to('/books/0-688-00230-7')),
+ *      Ensure.that(LastResponse.status(), equals(200)),
+ *      Ensure.that(LastResponse.body<Book>(), equals({
+ *          title: 'Zen and the Art of Motorcycle Maintenance: An Inquiry into Values',
+ *          author: 'Robert M. Pirsig',
+ *      })),
+ *    )
+ * ```
+ *
+ * ## Learn more
+ * - https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/GET
+ * - https://tools.ietf.org/html/rfc7231#section-4.3.1
+ *
+ * @group Models
+ */
+export class GetRequest extends HTTPRequest {
+
+    /**
+     * Configures the object with a destination URI.
+     *
+     * When the `resourceUri` is not a fully qualified URL but a path, such as `/products/2`,
+     * it gets concatenated with the URL provided to the Axios instance
+     * when the {@apilink Ability|ability} to {@apilink CallAnApi} was instantiated.
+     *
+     * @param resourceUri
+     *  The URI where the {@apilink Actor}
+     *  should send the {@apilink HTTPRequest}
+     */
+    static to(resourceUri: Answerable<string>): GetRequest {
+        return new GetRequest(resourceUri);
+    }
+
+    /**
+     * Overrides the default Axios request configuration provided
+     * when the {@apilink Ability|ability} to {@apilink CallAnApi} was instantiated.
+     *
+     * #### Learn more
+     * - {@apilink Answerable}
+     * - {@apilink WithAnswerableProperties}
+     * - [AxiosRequestConfig](https://github.com/axios/axios/blob/v0.27.2/index.d.ts#L75-L113)
+     *
+     * @param {Answerable<WithAnswerableProperties<AxiosRequestConfig>>} config
+     *  Axios request configuration overrides
+     */
+    using(config: Answerable<WithAnswerableProperties<AxiosRequestConfig>>): GetRequest {
+        return new GetRequest(this.resourceUri, undefined, Question.fromObject(config));
+    }
+}