@serenity-js/rest 3.41.1 → 3.42.0

package/esm/screenplay/models/PatchRequest.js

@@ -0,0 +1,70 @@
+import { Question } from '@serenity-js/core';
+import { HTTPRequest } from './HTTPRequest.js';
+/**
+ * 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 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 [ability](https://serenity-js.org/api/core/class/Ability/) to [`CallAnApi`](https://serenity-js.org/api/rest/class/CallAnApi/) was instantiated.
+     *
+     * @param resourceUri
+     *  The URI where the [`Actor`](https://serenity-js.org/api/core/class/Actor/)
+     *  should send the [`HTTPRequest`](https://serenity-js.org/api/rest/class/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 [ability](https://serenity-js.org/api/core/class/Ability/) to [`CallAnApi`](https://serenity-js.org/api/rest/class/CallAnApi/) was instantiated.
+     *
+     * #### Learn more
+     * - [`Answerable`](https://serenity-js.org/api/core/#Answerable)
+     * - [`WithAnswerableProperties`](https://serenity-js.org/api/core/#WithAnswerableProperties)
+     * - [AxiosRequestConfig](https://axios-http.com/docs/req_config)
+     *
+     * @param {Answerable<WithAnswerableProperties<AxiosRequestConfig>>} config
+     *  Axios request configuration overrides
+     */
+    using(config) {
+        return new PatchRequest(this.resourceUri, this.data, Question.fromObject(config));
+    }
+}
+//# sourceMappingURL=PatchRequest.js.map

package/esm/screenplay/models/PatchRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PatchRequest.js","sourceRoot":"","sources":["../../../src/screenplay/models/PatchRequest.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAG7C,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,OAAO,YAAa,SAAQ,WAAW;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,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;IACtF,CAAC;CACJ"}

package/esm/screenplay/models/PostRequest.d.ts

@@ -0,0 +1,105 @@
+import type { Answerable, WithAnswerableProperties } from '@serenity-js/core';
+import type { AxiosRequestConfig } from 'axios';
+import { HTTPRequest } from './HTTPRequest.js';
+/**
+ * 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(formData).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 [ability](https://serenity-js.org/api/core/class/Ability/) to [`CallAnApi`](https://serenity-js.org/api/rest/class/CallAnApi/) was instantiated.
+     *
+     * @param resourceUri
+     *  The URI where the [`Actor`](https://serenity-js.org/api/core/class/Actor/)
+     *  should send the [`HTTPRequest`](https://serenity-js.org/api/rest/class/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 [ability](https://serenity-js.org/api/core/class/Ability/) to [`CallAnApi`](https://serenity-js.org/api/rest/class/CallAnApi/) was instantiated.
+     *
+     * #### Learn more
+     * - [`Answerable`](https://serenity-js.org/api/core/#Answerable)
+     * - [`WithAnswerableProperties`](https://serenity-js.org/api/core/#WithAnswerableProperties)
+     * - [AxiosRequestConfig](https://axios-http.com/docs/req_config)
+     *
+     * @param {Answerable<WithAnswerableProperties<AxiosRequestConfig>>} config
+     *  Axios request configuration overrides
+     */
+    using(config: Answerable<WithAnswerableProperties<AxiosRequestConfig>>): PostRequest;
+}
+//# sourceMappingURL=PostRequest.d.ts.map

package/esm/screenplay/models/PostRequest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PostRequest.d.ts","sourceRoot":"","sources":["../../../src/screenplay/models/PostRequest.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,wBAAwB,EAAE,MAAM,mBAAmB,CAAC;AAE9E,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,OAAO,CAAC;AAEhD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;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/esm/screenplay/models/PostRequest.js

@@ -0,0 +1,110 @@
+import { Question } from '@serenity-js/core';
+import { HTTPRequest } from './HTTPRequest.js';
+/**
+ * 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(formData).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 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 [ability](https://serenity-js.org/api/core/class/Ability/) to [`CallAnApi`](https://serenity-js.org/api/rest/class/CallAnApi/) was instantiated.
+     *
+     * @param resourceUri
+     *  The URI where the [`Actor`](https://serenity-js.org/api/core/class/Actor/)
+     *  should send the [`HTTPRequest`](https://serenity-js.org/api/rest/class/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 [ability](https://serenity-js.org/api/core/class/Ability/) to [`CallAnApi`](https://serenity-js.org/api/rest/class/CallAnApi/) was instantiated.
+     *
+     * #### Learn more
+     * - [`Answerable`](https://serenity-js.org/api/core/#Answerable)
+     * - [`WithAnswerableProperties`](https://serenity-js.org/api/core/#WithAnswerableProperties)
+     * - [AxiosRequestConfig](https://axios-http.com/docs/req_config)
+     *
+     * @param {Answerable<WithAnswerableProperties<AxiosRequestConfig>>} config
+     *  Axios request configuration overrides
+     */
+    using(config) {
+        return new PostRequest(this.resourceUri, this.data, Question.fromObject(config));
+    }
+}
+//# sourceMappingURL=PostRequest.js.map

package/esm/screenplay/models/PostRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PostRequest.js","sourceRoot":"","sources":["../../../src/screenplay/models/PostRequest.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAG7C,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkEG;AACH,MAAM,OAAO,WAAY,SAAQ,WAAW;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,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;IACrF,CAAC;CACJ"}

package/esm/screenplay/models/PutRequest.d.ts

@@ -0,0 +1,75 @@
+import type { Answerable, WithAnswerableProperties } from '@serenity-js/core';
+import type { AxiosRequestConfig } from 'axios';
+import { HTTPRequest } from './HTTPRequest.js';
+/**
+ * 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('Apisitt')
+ *   .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 [ability](https://serenity-js.org/api/core/class/Ability/) to [`CallAnApi`](https://serenity-js.org/api/rest/class/CallAnApi/) was instantiated.
+     *
+     * @param resourceUri
+     *  The URI where the [`Actor`](https://serenity-js.org/api/core/class/Actor/)
+     *  should send the [`HTTPRequest`](https://serenity-js.org/api/rest/class/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 [ability](https://serenity-js.org/api/core/class/Ability/) to [`CallAnApi`](https://serenity-js.org/api/rest/class/CallAnApi/) was instantiated.
+     *
+     * #### Learn more
+     * - [`Answerable`](https://serenity-js.org/api/core/#Answerable)
+     * - [`WithAnswerableProperties`](https://serenity-js.org/api/core/#WithAnswerableProperties)
+     * - [AxiosRequestConfig](https://axios-http.com/docs/req_config)
+     *
+     * @param {Answerable<WithAnswerableProperties<AxiosRequestConfig>>} config
+     *  Axios request configuration overrides
+     */
+    using(config: Answerable<WithAnswerableProperties<AxiosRequestConfig>>): PutRequest;
+}
+//# sourceMappingURL=PutRequest.d.ts.map

package/esm/screenplay/models/PutRequest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PutRequest.d.ts","sourceRoot":"","sources":["../../../src/screenplay/models/PutRequest.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,wBAAwB,EAAE,MAAM,mBAAmB,CAAC;AAE9E,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,OAAO,CAAC;AAEhD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;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"}

package/esm/screenplay/models/PutRequest.js

@@ -0,0 +1,80 @@
+import { Question } from '@serenity-js/core';
+import { HTTPRequest } from './HTTPRequest.js';
+/**
+ * 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('Apisitt')
+ *   .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 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 [ability](https://serenity-js.org/api/core/class/Ability/) to [`CallAnApi`](https://serenity-js.org/api/rest/class/CallAnApi/) was instantiated.
+     *
+     * @param resourceUri
+     *  The URI where the [`Actor`](https://serenity-js.org/api/core/class/Actor/)
+     *  should send the [`HTTPRequest`](https://serenity-js.org/api/rest/class/HTTPRequest/)
+     */
+    static to(resourceUri) {
+        return new PutRequest(resourceUri);
+    }
+    /**
+     * Configures the object with a request body.
+     *
+     * @param data
+     *  Data to be sent to the `resourceUri`
+     */
+    with(data) {
+        return new PutRequest(this.resourceUri, data, this.config);
+    }
+    /**
+     * Overrides the default Axios request configuration provided
+     * when the [ability](https://serenity-js.org/api/core/class/Ability/) to [`CallAnApi`](https://serenity-js.org/api/rest/class/CallAnApi/) was instantiated.
+     *
+     * #### Learn more
+     * - [`Answerable`](https://serenity-js.org/api/core/#Answerable)
+     * - [`WithAnswerableProperties`](https://serenity-js.org/api/core/#WithAnswerableProperties)
+     * - [AxiosRequestConfig](https://axios-http.com/docs/req_config)
+     *
+     * @param {Answerable<WithAnswerableProperties<AxiosRequestConfig>>} config
+     *  Axios request configuration overrides
+     */
+    using(config) {
+        return new PutRequest(this.resourceUri, this.data, Question.fromObject(config));
+    }
+}
+//# sourceMappingURL=PutRequest.js.map

package/esm/screenplay/models/PutRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PutRequest.js","sourceRoot":"","sources":["../../../src/screenplay/models/PutRequest.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAG7C,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,MAAM,OAAO,UAAW,SAAQ,WAAW;IAEvC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,CAAC,WAA+B;QACrC,OAAO,IAAI,UAAU,CAAC,WAAW,CAAC,CAAC;IACvC,CAAC;IAED;;;;;OAKG;IACH,IAAI,CAAC,IAAqB;QACtB,OAAO,IAAI,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,MAAgE;QAClE,OAAO,IAAI,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;IACpF,CAAC;CACJ"}

package/esm/screenplay/models/index.d.ts

@@ -0,0 +1,9 @@
+export * from './DeleteRequest.js';
+export * from './GetRequest.js';
+export * from './HeadRequest.js';
+export * from './HTTPRequest.js';
+export * from './OptionsRequest.js';
+export * from './PatchRequest.js';
+export * from './PostRequest.js';
+export * from './PutRequest.js';
+//# sourceMappingURL=index.d.ts.map

package/esm/screenplay/models/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/screenplay/models/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC"}

package/esm/screenplay/models/index.js

@@ -0,0 +1,9 @@
+export * from './DeleteRequest.js';
+export * from './GetRequest.js';
+export * from './HeadRequest.js';
+export * from './HTTPRequest.js';
+export * from './OptionsRequest.js';
+export * from './PatchRequest.js';
+export * from './PostRequest.js';
+export * from './PutRequest.js';
+//# sourceMappingURL=index.js.map

package/esm/screenplay/models/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/screenplay/models/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC"}