@breadstone/archipel-mcp 0.0.1 → 0.0.2

package/data/packages/platform-core/api/Class.ResponseReturn.md

@@ -3,16 +3,15 @@ title: 'Abstract Class: ResponseReturn\<T\>'
 generated: true
 editUrl: false
 ---
-
 # Abstract Class: ResponseReturn\<T\>
 
-Defined in: [models/ResponseReturn.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L17)
+Defined in: [models/ResponseReturn.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L14)
 
 ## Type Parameters
 
 | Type Parameter |
-| -------------- |
-| `T`            |
+| ------ |
+| `T` |
 
 ## Constructors
 
@@ -34,9 +33,9 @@ new ResponseReturn<T>(): ResponseReturn<T>;
 optional data?: T;
 ```
 
-Defined in: [models/ResponseReturn.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L38)
+Defined in: [models/ResponseReturn.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L34)
 
----
+***
 
 ### details?
 
@@ -44,9 +43,9 @@ Defined in: [models/ResponseReturn.ts:38](https://github.com/RueDeRennes/archipe
 optional details?: unknown;
 ```
 
-Defined in: [models/ResponseReturn.ts:48](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L48)
+Defined in: [models/ResponseReturn.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L44)
 
----
+***
 
 ### error?
 
@@ -54,9 +53,9 @@ Defined in: [models/ResponseReturn.ts:48](https://github.com/RueDeRennes/archipe
 optional error?: string;
 ```
 
-Defined in: [models/ResponseReturn.ts:43](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L43)
+Defined in: [models/ResponseReturn.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L39)
 
----
+***
 
 ### status
 
@@ -64,9 +63,9 @@ Defined in: [models/ResponseReturn.ts:43](https://github.com/RueDeRennes/archipe
 status: number;
 ```
 
-Defined in: [models/ResponseReturn.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L33)
+Defined in: [models/ResponseReturn.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L29)
 
----
+***
 
 ### success
 
@@ -74,9 +73,9 @@ Defined in: [models/ResponseReturn.ts:33](https://github.com/RueDeRennes/archipe
 success: boolean;
 ```
 
-Defined in: [models/ResponseReturn.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L26)
+Defined in: [models/ResponseReturn.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L22)
 
----
+***
 
 ### timestamp
 
@@ -84,7 +83,7 @@ Defined in: [models/ResponseReturn.ts:26](https://github.com/RueDeRennes/archipe
 timestamp: string;
 ```
 
-Defined in: [models/ResponseReturn.ts:55](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L55)
+Defined in: [models/ResponseReturn.ts:51](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L51)
 
 ## Methods
 
@@ -96,23 +95,23 @@ Defined in: [models/ResponseReturn.ts:55](https://github.com/RueDeRennes/archipe
 static accepted<TReturn, TIn>(type, data): ResponseReturn<TReturn>;
 ```
 
-Defined in: [models/ResponseReturn.ts:94](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L94)
+Defined in: [models/ResponseReturn.ts:96](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L96)
 
 Creates an accepted response.
 
 ##### Type Parameters
 
 | Type Parameter |
-| -------------- |
-| `TReturn`      |
-| `TIn`          |
+| ------ |
+| `TReturn` |
+| `TIn` |
 
 ##### Parameters
 
-| Parameter | Type                            | Description                |
-| --------- | ------------------------------- | -------------------------- |
-| `type`    | `ClassConstructor`\<`TReturn`\> | Class type to transform to |
-| `data`    | `TIn`                           | The response data          |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `type` | `ClassConstructor`\<`TReturn`\> | Class type to transform to |
+| `data` | `TIn` | The response data |
 
 ##### Returns
 
@@ -124,29 +123,29 @@ Creates an accepted response.
 static accepted<TReturn, TIn>(type, data): ResponseReturn<TReturn[]>;
 ```
 
-Defined in: [models/ResponseReturn.ts:95](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L95)
+Defined in: [models/ResponseReturn.ts:97](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L97)
 
 Creates an accepted response.
 
 ##### Type Parameters
 
 | Type Parameter |
-| -------------- |
-| `TReturn`      |
-| `TIn`          |
+| ------ |
+| `TReturn` |
+| `TIn` |
 
 ##### Parameters
 
-| Parameter | Type                            | Description                |
-| --------- | ------------------------------- | -------------------------- |
-| `type`    | `ClassConstructor`\<`TReturn`\> | Class type to transform to |
-| `data`    | `TIn`[]                         | The response data          |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `type` | `ClassConstructor`\<`TReturn`\> | Class type to transform to |
+| `data` | `TIn`[] | The response data |
 
 ##### Returns
 
 `ResponseReturn`\<`TReturn`[]\>
 
----
+***
 
 ### badRequest()
 
@@ -154,22 +153,22 @@ Creates an accepted response.
 static badRequest<TReturn>(message?, details?): ResponseReturn<TReturn>;
 ```
 
-Defined in: [models/ResponseReturn.ts:122](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L122)
+Defined in: [models/ResponseReturn.ts:127](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L127)
 
 Creates a bad request response.
 
 #### Type Parameters
 
 | Type Parameter |
-| -------------- |
-| `TReturn`      |
+| ------ |
+| `TReturn` |
 
 #### Parameters
 
-| Parameter  | Type      | Default value   | Description                  |
-| ---------- | --------- | --------------- | ---------------------------- |
-| `message`  | `string`  | `'Bad Request'` | Human-readable error message |
-| `details?` | `unknown` | `undefined`     | Optional error details       |
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `message` | `string` | `'Bad Request'` | Human-readable error message |
+| `details?` | `unknown` | `undefined` | Optional error details |
 
 #### Returns
 
@@ -177,7 +176,7 @@ Creates a bad request response.
 
 Bad request response
 
----
+***
 
 ### conflict()
 
@@ -185,22 +184,22 @@ Bad request response
 static conflict<TReturn>(message?, details?): ResponseReturn<TReturn>;
 ```
 
-Defined in: [models/ResponseReturn.ts:170](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L170)
+Defined in: [models/ResponseReturn.ts:175](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L175)
 
 Creates a conflict response.
 
 #### Type Parameters
 
 | Type Parameter |
-| -------------- |
-| `TReturn`      |
+| ------ |
+| `TReturn` |
 
 #### Parameters
 
-| Parameter  | Type      | Default value | Description                  |
-| ---------- | --------- | ------------- | ---------------------------- |
-| `message`  | `string`  | `'Conflict'`  | Human-readable error message |
-| `details?` | `unknown` | `undefined`   | Optional error details       |
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `message` | `string` | `'Conflict'` | Human-readable error message |
+| `details?` | `unknown` | `undefined` | Optional error details |
 
 #### Returns
 
@@ -208,7 +207,7 @@ Creates a conflict response.
 
 Conflict response
 
----
+***
 
 ### created()
 
@@ -218,23 +217,23 @@ Conflict response
 static created<TReturn, TIn>(type, data): ResponseReturn<TReturn>;
 ```
 
-Defined in: [models/ResponseReturn.ts:81](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L81)
+Defined in: [models/ResponseReturn.ts:80](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L80)
 
 Creates a resource created response.
 
 ##### Type Parameters
 
 | Type Parameter |
-| -------------- |
-| `TReturn`      |
-| `TIn`          |
+| ------ |
+| `TReturn` |
+| `TIn` |
 
 ##### Parameters
 
-| Parameter | Type                            | Description                |
-| --------- | ------------------------------- | -------------------------- |
-| `type`    | `ClassConstructor`\<`TReturn`\> | Class type to transform to |
-| `data`    | `TIn`                           | The response data          |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `type` | `ClassConstructor`\<`TReturn`\> | Class type to transform to |
+| `data` | `TIn` | The response data |
 
 ##### Returns
 
@@ -246,29 +245,29 @@ Creates a resource created response.
 static created<TReturn, TIn>(type, data): ResponseReturn<TReturn[]>;
 ```
 
-Defined in: [models/ResponseReturn.ts:82](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L82)
+Defined in: [models/ResponseReturn.ts:81](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L81)
 
 Creates a resource created response.
 
 ##### Type Parameters
 
 | Type Parameter |
-| -------------- |
-| `TReturn`      |
-| `TIn`          |
+| ------ |
+| `TReturn` |
+| `TIn` |
 
 ##### Parameters
 
-| Parameter | Type                            | Description                |
-| --------- | ------------------------------- | -------------------------- |
-| `type`    | `ClassConstructor`\<`TReturn`\> | Class type to transform to |
-| `data`    | `TIn`[]                         | The response data          |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `type` | `ClassConstructor`\<`TReturn`\> | Class type to transform to |
+| `data` | `TIn`[] | The response data |
 
 ##### Returns
 
 `ResponseReturn`\<`TReturn`[]\>
 
----
+***
 
 ### error()
 
@@ -276,28 +275,28 @@ Creates a resource created response.
 static error<TReturn>(message?, details?): ResponseReturn<TReturn>;
 ```
 
-Defined in: [models/ResponseReturn.ts:177](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L177)
+Defined in: [models/ResponseReturn.ts:182](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L182)
 
 Generic server error (500). Prefer attaching a safe `details` object (no stack traces in prod).
 
 #### Type Parameters
 
 | Type Parameter |
-| -------------- |
-| `TReturn`      |
+| ------ |
+| `TReturn` |
 
 #### Parameters
 
-| Parameter  | Type      | Default value             |
-| ---------- | --------- | ------------------------- |
-| `message`  | `string`  | `'Internal Server Error'` |
-| `details?` | `unknown` | `undefined`               |
+| Parameter | Type | Default value |
+| ------ | ------ | ------ |
+| `message` | `string` | `'Internal Server Error'` |
+| `details?` | `unknown` | `undefined` |
 
 #### Returns
 
 `ResponseReturn`\<`TReturn`\>
 
----
+***
 
 ### forbidden()
 
@@ -305,22 +304,22 @@ Generic server error (500). Prefer attaching a safe `details` object (no stack t
 static forbidden<TReturn>(message?, details?): ResponseReturn<TReturn>;
 ```
 
-Defined in: [models/ResponseReturn.ts:146](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L146)
+Defined in: [models/ResponseReturn.ts:151](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L151)
 
 Creates a forbidden response.
 
 #### Type Parameters
 
 | Type Parameter |
-| -------------- |
-| `TReturn`      |
+| ------ |
+| `TReturn` |
 
 #### Parameters
 
-| Parameter  | Type      | Default value | Description                  |
-| ---------- | --------- | ------------- | ---------------------------- |
-| `message`  | `string`  | `'Forbidden'` | Human-readable error message |
-| `details?` | `unknown` | `undefined`   | Optional error details       |
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `message` | `string` | `'Forbidden'` | Human-readable error message |
+| `details?` | `unknown` | `undefined` | Optional error details |
 
 #### Returns
 
@@ -328,7 +327,7 @@ Creates a forbidden response.
 
 Forbidden response
 
----
+***
 
 ### fromError()
 
@@ -336,30 +335,29 @@ Forbidden response
 static fromError<TReturn>(err, defaultStatus?): ResponseReturn<TReturn>;
 ```
 
-Defined in: [models/ResponseReturn.ts:185](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L185)
+Defined in: [models/ResponseReturn.ts:190](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L190)
 
 Converts an arbitrary error into a ResponseReturn.
-
 - If you pass a Nest `HttpException`, consider extracting status/message first.
 
 #### Type Parameters
 
 | Type Parameter |
-| -------------- |
-| `TReturn`      |
+| ------ |
+| `TReturn` |
 
 #### Parameters
 
-| Parameter       | Type         | Default value                      |
-| --------------- | ------------ | ---------------------------------- |
-| `err`           | `unknown`    | `undefined`                        |
+| Parameter | Type | Default value |
+| ------ | ------ | ------ |
+| `err` | `unknown` | `undefined` |
 | `defaultStatus` | `HttpStatus` | `HttpStatus.INTERNAL_SERVER_ERROR` |
 
 #### Returns
 
 `ResponseReturn`\<`TReturn`\>
 
----
+***
 
 ### noContent()
 
@@ -367,21 +365,21 @@ Converts an arbitrary error into a ResponseReturn.
 static noContent<TReturn>(): ResponseReturn<TReturn>;
 ```
 
-Defined in: [models/ResponseReturn.ts:105](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L105)
+Defined in: [models/ResponseReturn.ts:110](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L110)
 
 No content variant (204). `data` is undefined by contract.
 
 #### Type Parameters
 
 | Type Parameter |
-| -------------- |
-| `TReturn`      |
+| ------ |
+| `TReturn` |
 
 #### Returns
 
 `ResponseReturn`\<`TReturn`\>
 
----
+***
 
 ### notFound()
 
@@ -389,22 +387,22 @@ No content variant (204). `data` is undefined by contract.
 static notFound<TReturn>(message?, details?): ResponseReturn<TReturn>;
 ```
 
-Defined in: [models/ResponseReturn.ts:158](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L158)
+Defined in: [models/ResponseReturn.ts:163](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L163)
 
 Creates a not found response.
 
 #### Type Parameters
 
 | Type Parameter |
-| -------------- |
-| `TReturn`      |
+| ------ |
+| `TReturn` |
 
 #### Parameters
 
-| Parameter  | Type      | Default value | Description                  |
-| ---------- | --------- | ------------- | ---------------------------- |
-| `message`  | `string`  | `'Not Found'` | Human-readable error message |
-| `details?` | `unknown` | `undefined`   | Optional error details       |
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `message` | `string` | `'Not Found'` | Human-readable error message |
+| `details?` | `unknown` | `undefined` | Optional error details |
 
 #### Returns
 
@@ -412,7 +410,7 @@ Creates a not found response.
 
 Not found response
 
----
+***
 
 ### ok()
 
@@ -422,23 +420,23 @@ Not found response
 static ok<TReturn, TIn>(type, data): ResponseReturn<TReturn>;
 ```
 
-Defined in: [models/ResponseReturn.ts:68](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L68)
+Defined in: [models/ResponseReturn.ts:64](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L64)
 
 Creates a successful response.
 
 ##### Type Parameters
 
 | Type Parameter |
-| -------------- |
-| `TReturn`      |
-| `TIn`          |
+| ------ |
+| `TReturn` |
+| `TIn` |
 
 ##### Parameters
 
-| Parameter | Type                            | Description                |
-| --------- | ------------------------------- | -------------------------- |
-| `type`    | `ClassConstructor`\<`TReturn`\> | Class type to transform to |
-| `data`    | `TIn`                           | The response data          |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `type` | `ClassConstructor`\<`TReturn`\> | Class type to transform to |
+| `data` | `TIn` | The response data |
 
 ##### Returns
 
@@ -450,29 +448,29 @@ Creates a successful response.
 static ok<TReturn, TIn>(type, data): ResponseReturn<TReturn[]>;
 ```
 
-Defined in: [models/ResponseReturn.ts:69](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L69)
+Defined in: [models/ResponseReturn.ts:65](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L65)
 
 Creates a successful response.
 
 ##### Type Parameters
 
 | Type Parameter |
-| -------------- |
-| `TReturn`      |
-| `TIn`          |
+| ------ |
+| `TReturn` |
+| `TIn` |
 
 ##### Parameters
 
-| Parameter | Type                            | Description                |
-| --------- | ------------------------------- | -------------------------- |
-| `type`    | `ClassConstructor`\<`TReturn`\> | Class type to transform to |
-| `data`    | `TIn`[]                         | The response data          |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `type` | `ClassConstructor`\<`TReturn`\> | Class type to transform to |
+| `data` | `TIn`[] | The response data |
 
 ##### Returns
 
 `ResponseReturn`\<`TReturn`[]\>
 
----
+***
 
 ### unauthorized()
 
@@ -480,22 +478,22 @@ Creates a successful response.
 static unauthorized<TReturn>(message?, details?): ResponseReturn<TReturn>;
 ```
 
-Defined in: [models/ResponseReturn.ts:134](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L134)
+Defined in: [models/ResponseReturn.ts:139](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L139)
 
 Creates an unauthorized response.
 
 #### Type Parameters
 
 | Type Parameter |
-| -------------- |
-| `TReturn`      |
+| ------ |
+| `TReturn` |
 
 #### Parameters
 
-| Parameter  | Type      | Default value    | Description                  |
-| ---------- | --------- | ---------------- | ---------------------------- |
-| `message`  | `string`  | `'Unauthorized'` | Human-readable error message |
-| `details?` | `unknown` | `undefined`      | Optional error details       |
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `message` | `string` | `'Unauthorized'` | Human-readable error message |
+| `details?` | `unknown` | `undefined` | Optional error details |
 
 #### Returns