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

package/lib/models/OptionsRequest.d.ts

@@ -0,0 +1,61 @@
+import { Answerable, WithAnswerableProperties } from '@serenity-js/core';
+import { AxiosRequestConfig } from 'axios';
+import { HTTPRequest } from './HTTPRequest';
+/**
+ * The OPTIONS method requests information about the communication
+ * options available for the target resource, at either the origin
+ * server or an intervening intermediary.  This method allows a client
+ * to determine the options and/or requirements associated with a
+ * resource, or the capabilities of a server, without implying a
+ * resource action.
+ *
+ * ## File download test
+ *
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core'
+ * import { CallAnApi, OptionsRequest, LastResponse, Send } from '@serenity-js/rest'
+ * import { Ensure, equals } from '@serenity-js/assertions'
+ *
+ * await actorCalled('Apisitt')
+ *   .whoCan(CallAnApi.at('https://api.example.org/'))
+ *   .attemptsTo(
+ *     Send.a(OptionsRequest.to('/downloads/my-test-document.pdf')),
+ *     Ensure.that(LastResponse.status(), equals(200)),
+ *     Ensure.that(LastResponse.header('Allow'), equals('OPTIONS, GET, HEAD')),
+ *   )
+ * ```
+ *
+ * ## Learn more
+ * - https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/OPTIONS
+ * - https://tools.ietf.org/html/rfc7231#section-4.3.7
+ *
+ * @group Models
+ */
+export declare class OptionsRequest 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>): OptionsRequest;
+    /**
+     * 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>>): OptionsRequest;
+}
+//# sourceMappingURL=OptionsRequest.d.ts.map

package/lib/models/OptionsRequest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"OptionsRequest.d.ts","sourceRoot":"","sources":["../../src/models/OptionsRequest.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAY,wBAAwB,EAAE,MAAM,mBAAmB,CAAC;AACnF,OAAO,EAAE,kBAAkB,EAAE,MAAM,OAAO,CAAC;AAE3C,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,qBAAa,cAAe,SAAQ,WAAW;IAE3C;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,UAAU,CAAC,MAAM,CAAC,GAAG,cAAc;IAI1D;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,MAAM,EAAE,UAAU,CAAC,wBAAwB,CAAC,kBAAkB,CAAC,CAAC,GAAG,cAAc;CAG1F"}

package/lib/models/OptionsRequest.js

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OptionsRequest = void 0;
+const core_1 = require("@serenity-js/core");
+const HTTPRequest_1 = require("./HTTPRequest");
+/**
+ * The OPTIONS method requests information about the communication
+ * options available for the target resource, at either the origin
+ * server or an intervening intermediary.  This method allows a client
+ * to determine the options and/or requirements associated with a
+ * resource, or the capabilities of a server, without implying a
+ * resource action.
+ *
+ * ## File download test
+ *
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core'
+ * import { CallAnApi, OptionsRequest, LastResponse, Send } from '@serenity-js/rest'
+ * import { Ensure, equals } from '@serenity-js/assertions'
+ *
+ * await actorCalled('Apisitt')
+ *   .whoCan(CallAnApi.at('https://api.example.org/'))
+ *   .attemptsTo(
+ *     Send.a(OptionsRequest.to('/downloads/my-test-document.pdf')),
+ *     Ensure.that(LastResponse.status(), equals(200)),
+ *     Ensure.that(LastResponse.header('Allow'), equals('OPTIONS, GET, HEAD')),
+ *   )
+ * ```
+ *
+ * ## Learn more
+ * - https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/OPTIONS
+ * - https://tools.ietf.org/html/rfc7231#section-4.3.7
+ *
+ * @group Models
+ */
+class OptionsRequest extends HTTPRequest_1.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) {
+        return new OptionsRequest(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) {
+        return new OptionsRequest(this.resourceUri, undefined, core_1.Question.fromObject(config));
+    }
+}
+exports.OptionsRequest = OptionsRequest;
+//# sourceMappingURL=OptionsRequest.js.map

package/lib/models/OptionsRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OptionsRequest.js","sourceRoot":"","sources":["../../src/models/OptionsRequest.ts"],"names":[],"mappings":";;;AAAA,4CAAmF;AAGnF,+CAA4C;AAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAa,cAAe,SAAQ,yBAAW;IAE3C;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,CAAC,WAA+B;QACrC,OAAO,IAAI,cAAc,CAAC,WAAW,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,MAAgE;QAClE,OAAO,IAAI,cAAc,CAAC,IAAI,CAAC,WAAW,EAAE,SAAS,EAAE,eAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;IACxF,CAAC;CACJ;AAhCD,wCAgCC"}

package/lib/models/PatchRequest.d.ts

@@ -0,0 +1,65 @@
+import { Answerable, WithAnswerableProperties } from '@serenity-js/core';
+import { AxiosRequestConfig } from 'axios';
+import { HTTPRequest } from './HTTPRequest';
+/**
+ * The PATCH method requests that a set of changes described in the
+ * request entity be applied to the resource identified by the `resourceUri`.
+ *
+ * ## Add new resource to a collection
+ *
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core'
+ * import { CallAnApi, LastResponse, PatchRequest, Send } from '@serenity-js/rest'
+ * import { Ensure, equals } from '@serenity-js/assertions'
+ *
+ * await actorCalled('Apisitt')
+ *   .whoCan(CallAnApi.at('https://api.example.org/'))
+ *   .attemptsTo(
+ *     Send.a(PatchRequest.to('/books/0-688-00230-7').with({
+ *       lastReadOn: '2016-06-16',
+ *     })),
+ *     Ensure.that(LastResponse.status(), equals(204)),
+ *   )
+ * ```
+ *
+ * ## Learn more
+ * - https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PATCH
+ * - https://tools.ietf.org/html/rfc5789
+ *
+ * @group Models
+ */
+export declare class PatchRequest 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>): PatchRequest;
+    /**
+     * Configures the object with a request body.
+     *
+     * @param data
+     *  Data to be sent to the `resourceUri`
+     */
+    with(data: Answerable<any>): PatchRequest;
+    /**
+     * 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>>): PatchRequest;
+}
+//# sourceMappingURL=PatchRequest.d.ts.map

package/lib/models/PatchRequest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PatchRequest.d.ts","sourceRoot":"","sources":["../../src/models/PatchRequest.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAY,wBAAwB,EAAE,MAAM,mBAAmB,CAAC;AACnF,OAAO,EAAE,kBAAkB,EAAE,MAAM,OAAO,CAAC;AAE3C,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAEzC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,UAAU,CAAC,MAAM,CAAC,GAAG,YAAY;IAIxD;;;;;OAKG;IACH,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,GAAG,CAAC,GAAG,YAAY;IAIzC;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,MAAM,EAAE,UAAU,CAAC,wBAAwB,CAAC,kBAAkB,CAAC,CAAC,GAAG,YAAY;CAGxF"}

package/lib/models/PatchRequest.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PatchRequest = void 0;
+const core_1 = require("@serenity-js/core");
+const HTTPRequest_1 = require("./HTTPRequest");
+/**
+ * The PATCH method requests that a set of changes described in the
+ * request entity be applied to the resource identified by the `resourceUri`.
+ *
+ * ## Add new resource to a collection
+ *
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core'
+ * import { CallAnApi, LastResponse, PatchRequest, Send } from '@serenity-js/rest'
+ * import { Ensure, equals } from '@serenity-js/assertions'
+ *
+ * await actorCalled('Apisitt')
+ *   .whoCan(CallAnApi.at('https://api.example.org/'))
+ *   .attemptsTo(
+ *     Send.a(PatchRequest.to('/books/0-688-00230-7').with({
+ *       lastReadOn: '2016-06-16',
+ *     })),
+ *     Ensure.that(LastResponse.status(), equals(204)),
+ *   )
+ * ```
+ *
+ * ## Learn more
+ * - https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PATCH
+ * - https://tools.ietf.org/html/rfc5789
+ *
+ * @group Models
+ */
+class PatchRequest extends HTTPRequest_1.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) {
+        return new PatchRequest(resourceUri);
+    }
+    /**
+     * Configures the object with a request body.
+     *
+     * @param data
+     *  Data to be sent to the `resourceUri`
+     */
+    with(data) {
+        return new PatchRequest(this.resourceUri, data, this.config);
+    }
+    /**
+     * 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) {
+        return new PatchRequest(this.resourceUri, this.data, core_1.Question.fromObject(config));
+    }
+}
+exports.PatchRequest = PatchRequest;
+//# sourceMappingURL=PatchRequest.js.map

package/lib/models/PatchRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PatchRequest.js","sourceRoot":"","sources":["../../src/models/PatchRequest.ts"],"names":[],"mappings":";;;AAAA,4CAAmF;AAGnF,+CAA4C;AAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAa,YAAa,SAAQ,yBAAW;IAEzC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,CAAC,WAA+B;QACrC,OAAO,IAAI,YAAY,CAAC,WAAW,CAAC,CAAC;IACzC,CAAC;IAED;;;;;OAKG;IACH,IAAI,CAAC,IAAqB;QACtB,OAAO,IAAI,YAAY,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,MAAgE;QAClE,OAAO,IAAI,YAAY,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,IAAI,EAAE,eAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;IACtF,CAAC;CACJ;AA1CD,oCA0CC"}

package/lib/models/PostRequest.d.ts

@@ -0,0 +1,105 @@
+import { Answerable, WithAnswerableProperties } from '@serenity-js/core';
+import { AxiosRequestConfig } from 'axios';
+import { HTTPRequest } from './HTTPRequest';
+/**
+ * The HTTP POST method requests that the origin server accepts
+ * the entity enclosed in the request as a new subordinate of the resource
+ * identified by the `resourceUri`.
+ *
+ * This means that the POST should be used when you want to create a child resource under
+ * a collection of resources.
+ *
+ * POST request is neither [safe](https://developer.mozilla.org/en-US/docs/Glossary/Safe),
+ * nor [idempotent](https://developer.mozilla.org/en-US/docs/Glossary/Idempotent).
+ * This means that if you retry a POST request N times,
+ * a correctly implemented HTTP REST API will create N resources with N different URIs.
+ *
+ * ## Add new resource to a collection
+ *
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core'
+ * import { CallAnApi, LastResponse, PostRequest, Send } from '@serenity-js/rest'
+ * import { Ensure, equals } from '@serenity-js/assertions'
+ *
+ * await actorCalled('Apisitt')
+ *   .whoCan(CallAnApi.at('https://api.example.org/'))
+ *   .attemptsTo(
+ *     Send.a(PostRequest.to('/books').with({
+ *       isbn: '0-688-00230-7',
+ *       title: 'Zen and the Art of Motorcycle Maintenance: An Inquiry into Values',
+ *       author: 'Robert M. Pirsig',
+ *     })),
+ *     Ensure.that(LastResponse.status(), equals(201)),
+ *     Ensure.that(LastResponse.header('Location'), equals('/books/0-688-00230-7')),
+ *   )
+ * ```
+ *
+ * ## Submit an HTML form
+ *
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core'
+ * import { CallAnApi, LastResponse, PostRequest, Send } from '@serenity-js/rest'
+ * import { Ensure, equals } from '@serenity-js/assertions'
+ * import { stringify } from 'querystring'
+ *
+ * const formData = stringify({
+ *     name: actor.name,
+ *     email: `${ actor.name }@example.com`,
+ *     text: 'Your website is great! Learnt a lot :-)'
+ * });
+ *
+ * await actorCalled('Apisitt')
+ *   .whoCan(CallAnApi.at('https://api.example.org/'))
+ *   .attemptsTo(
+ *     Send.a(PostRequest.to('/feedback').with(postData).using({
+ *       headers: {
+ *         'Content-Type': 'application/x-www-form-urlencoded',
+ *         'Content-Length': formData.length
+ *       }
+ *     })),
+ *     Ensure.that(LastResponse.status(), equals(200)),
+ *     Ensure.that(LastResponse.header('Location'), equals('/feedback/thank-you.html')),
+ *   )
+ * ```
+ *
+ * ## Learn more
+ * - https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST
+ * - https://tools.ietf.org/html/rfc7231#section-4.3.3
+ *
+ * @group Models
+ */
+export declare class PostRequest 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>): PostRequest;
+    /**
+     * Configures the object with a request body.
+     *
+     * @param data
+     *  Data to be sent to the `resourceUri`
+     */
+    with(data: Answerable<any>): PostRequest;
+    /**
+     * 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>>): PostRequest;
+}
+//# sourceMappingURL=PostRequest.d.ts.map

package/lib/models/PostRequest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PostRequest.d.ts","sourceRoot":"","sources":["../../src/models/PostRequest.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAY,wBAAwB,EAAE,MAAM,mBAAmB,CAAC;AACnF,OAAO,EAAE,kBAAkB,EAAE,MAAM,OAAO,CAAC;AAE3C,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkEG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAExC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,UAAU,CAAC,MAAM,CAAC,GAAG,WAAW;IAIvD;;;;;OAKG;IACH,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,GAAG,CAAC,GAAG,WAAW;IAIxC;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,MAAM,EAAE,UAAU,CAAC,wBAAwB,CAAC,kBAAkB,CAAC,CAAC,GAAG,WAAW;CAGvF"}

package/lib/models/PostRequest.js

@@ -0,0 +1,114 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PostRequest = void 0;
+const core_1 = require("@serenity-js/core");
+const HTTPRequest_1 = require("./HTTPRequest");
+/**
+ * The HTTP POST method requests that the origin server accepts
+ * the entity enclosed in the request as a new subordinate of the resource
+ * identified by the `resourceUri`.
+ *
+ * This means that the POST should be used when you want to create a child resource under
+ * a collection of resources.
+ *
+ * POST request is neither [safe](https://developer.mozilla.org/en-US/docs/Glossary/Safe),
+ * nor [idempotent](https://developer.mozilla.org/en-US/docs/Glossary/Idempotent).
+ * This means that if you retry a POST request N times,
+ * a correctly implemented HTTP REST API will create N resources with N different URIs.
+ *
+ * ## Add new resource to a collection
+ *
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core'
+ * import { CallAnApi, LastResponse, PostRequest, Send } from '@serenity-js/rest'
+ * import { Ensure, equals } from '@serenity-js/assertions'
+ *
+ * await actorCalled('Apisitt')
+ *   .whoCan(CallAnApi.at('https://api.example.org/'))
+ *   .attemptsTo(
+ *     Send.a(PostRequest.to('/books').with({
+ *       isbn: '0-688-00230-7',
+ *       title: 'Zen and the Art of Motorcycle Maintenance: An Inquiry into Values',
+ *       author: 'Robert M. Pirsig',
+ *     })),
+ *     Ensure.that(LastResponse.status(), equals(201)),
+ *     Ensure.that(LastResponse.header('Location'), equals('/books/0-688-00230-7')),
+ *   )
+ * ```
+ *
+ * ## Submit an HTML form
+ *
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core'
+ * import { CallAnApi, LastResponse, PostRequest, Send } from '@serenity-js/rest'
+ * import { Ensure, equals } from '@serenity-js/assertions'
+ * import { stringify } from 'querystring'
+ *
+ * const formData = stringify({
+ *     name: actor.name,
+ *     email: `${ actor.name }@example.com`,
+ *     text: 'Your website is great! Learnt a lot :-)'
+ * });
+ *
+ * await actorCalled('Apisitt')
+ *   .whoCan(CallAnApi.at('https://api.example.org/'))
+ *   .attemptsTo(
+ *     Send.a(PostRequest.to('/feedback').with(postData).using({
+ *       headers: {
+ *         'Content-Type': 'application/x-www-form-urlencoded',
+ *         'Content-Length': formData.length
+ *       }
+ *     })),
+ *     Ensure.that(LastResponse.status(), equals(200)),
+ *     Ensure.that(LastResponse.header('Location'), equals('/feedback/thank-you.html')),
+ *   )
+ * ```
+ *
+ * ## Learn more
+ * - https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST
+ * - https://tools.ietf.org/html/rfc7231#section-4.3.3
+ *
+ * @group Models
+ */
+class PostRequest extends HTTPRequest_1.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) {
+        return new PostRequest(resourceUri);
+    }
+    /**
+     * Configures the object with a request body.
+     *
+     * @param data
+     *  Data to be sent to the `resourceUri`
+     */
+    with(data) {
+        return new PostRequest(this.resourceUri, data, this.config);
+    }
+    /**
+     * 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) {
+        return new PostRequest(this.resourceUri, this.data, core_1.Question.fromObject(config));
+    }
+}
+exports.PostRequest = PostRequest;
+//# sourceMappingURL=PostRequest.js.map

package/lib/models/PostRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PostRequest.js","sourceRoot":"","sources":["../../src/models/PostRequest.ts"],"names":[],"mappings":";;;AAAA,4CAAmF;AAGnF,+CAA4C;AAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkEG;AACH,MAAa,WAAY,SAAQ,yBAAW;IAExC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,CAAC,WAA+B;QACrC,OAAO,IAAI,WAAW,CAAC,WAAW,CAAC,CAAC;IACxC,CAAC;IAED;;;;;OAKG;IACH,IAAI,CAAC,IAAqB;QACtB,OAAO,IAAI,WAAW,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,MAAgE;QAClE,OAAO,IAAI,WAAW,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,IAAI,EAAE,eAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;IACrF,CAAC;CACJ;AA1CD,kCA0CC"}

package/lib/models/PutRequest.d.ts

@@ -0,0 +1,75 @@
+import { Answerable, WithAnswerableProperties } from '@serenity-js/core';
+import { AxiosRequestConfig } from 'axios';
+import { HTTPRequest } from './HTTPRequest';
+/**
+ * The PUT method requests that the state of the target resource be
+ * created or replaced with the state defined by the representation
+ * enclosed in the request message payload.
+ *
+ * PUT request should be used when you want to create
+ * a new resource at a known `resourceUri` (e.g. `/books/0-688-00230-7`)
+ * or replace an existing resource at such `resourceUri`.
+ *
+ * PUT request is [idempotent](https://developer.mozilla.org/en-US/docs/Glossary/Idempotent):
+ * calling it once or several times successively has the same effect (that is no _side effect_).
+ *
+ * ## Create a new resource at a known location
+ *
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core';
+ * import { CallAnApi, LastResponse, PutRequest, Send } from '@serenity-js/rest';
+ * import { Ensure, equals } from '@serenity-js/assertions';
+ *
+ * await actorCalled('Apisit')
+ *   .whoCan(CallAnApi.at('https://api.example.org/'))
+ *   .attemptsTo(
+ *     Send.a(PutRequest.to('/books/0-688-00230-7').with({
+ *       isbn: '0-688-00230-7',
+ *       title: 'Zen and the Art of Motorcycle Maintenance: An Inquiry into Values',
+ *       author: 'Robert M. Pirsig',
+ *     })),
+ *     Ensure.that(LastResponse.status(), equals(201)),
+ *   )
+ * ```
+ *
+ * ## Learn more
+ * - https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PUT
+ * - https://tools.ietf.org/html/rfc7231#section-4.3.4
+ *
+ * @group Models
+ */
+export declare class PutRequest 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>): PutRequest;
+    /**
+     * Configures the object with a request body.
+     *
+     * @param data
+     *  Data to be sent to the `resourceUri`
+     */
+    with(data: Answerable<any>): PutRequest;
+    /**
+     * 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>>): PutRequest;
+}
+//# sourceMappingURL=PutRequest.d.ts.map

package/lib/models/PutRequest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PutRequest.d.ts","sourceRoot":"","sources":["../../src/models/PutRequest.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAY,wBAAwB,EAAE,MAAM,mBAAmB,CAAC;AACnF,OAAO,EAAE,kBAAkB,EAAE,MAAM,OAAO,CAAC;AAE3C,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,qBAAa,UAAW,SAAQ,WAAW;IAEvC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,UAAU,CAAC,MAAM,CAAC,GAAG,UAAU;IAItD;;;;;OAKG;IACH,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,GAAG,CAAC,GAAG,UAAU;IAIvC;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,MAAM,EAAE,UAAU,CAAC,wBAAwB,CAAC,kBAAkB,CAAC,CAAC,GAAG,UAAU;CAGtF"}