@mountainpass/problem-document 0.0.2 → 0.0.3

package/lib/index.d.ts

@@ -1,361 +1,501 @@
+/**
+ * Http Status Codes from https://github.com/prettymuchbryce/http-status-codes/blob/master/src/status-codes.ts under MIT License
+ * If you know how to convert numeric enum values to a union type, please submit a PR.
+ */
 declare type StatusCode = 
-/** ACCEPTED
-* Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.3.3
-*
-* The request has been received but not yet acted upon. It is non-committal, meaning that there is no way in HTTP to later send an asynchronous response indicating the outcome of processing the request. It is intended for cases where another process or server handles the request, or for batch processing.
-*/
-202 | 
-/** BAD_GATEWAY
-* Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.6.3
-*
-* This error response means that the server, while working as a gateway to get a response needed to handle the request, got an invalid response.
-*/
-502 | 
-/** BAD_REQUEST
-* Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.1
-*
-* This response means that server could not understand the request due to invalid syntax.
-*/
-400 | 
-/** CONFLICT
-* Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.8
-*
-* This response is sent when a request conflicts with the current state of the server.
-*/
-409 | 
-/** CONTINUE
-* Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.2.1
-*
-* This interim response indicates that everything so far is OK and that the client should continue with the request or ignore it if it is already finished.
-*/
-100 | 
-/** CREATED
-* Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.3.2
-*
-* The request has succeeded and a new resource has been created as a result of it. This is typically the response sent after a PUT request.
-*/
-201 | 
-/** EXPECTATION_FAILED
-* Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.14
-*
-* This response code means the expectation indicated by the Expect request header field can't be met by the server.
-*/
-417 | 
-/** FAILED_DEPENDENCY
-* Official Documentation @ https://tools.ietf.org/html/rfc2518#section-10.5
-*
-* The request failed due to failure of a previous request.
-*/
-424 | 
-/** FORBIDDEN
-* Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.3
-*
-* The client does not have access rights to the content, i.e. they are unauthorized, so server is rejecting to give proper response. Unlike 401, the client's identity is known to the server.
-*/
-403 | 
-/** GATEWAY_TIMEOUT
-* Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.6.5
-*
-* This error response is given when the server is acting as a gateway and cannot get a response in time.
-*/
-504 | 
-/** GONE
-* Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.9
-*
-* This response would be sent when the requested content has been permanently deleted from server, with no forwarding address. Clients are expected to remove their caches and links to the resource. The HTTP specification intends this status code to be used for "limited-time, promotional services". APIs should not feel compelled to indicate resources that have been deleted with this status code.
-*/
-410 | 
-/** HTTP_VERSION_NOT_SUPPORTED
-* Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.6.6
-*
-* The HTTP version used in the request is not supported by the server.
-*/
-505 | 
-/** IM_A_TEAPOT
-* Official Documentation @ https://tools.ietf.org/html/rfc2324#section-2.3.2
-*
-* Any attempt to brew coffee with a teapot should result in the error code "418 I'm a teapot". The resulting entity body MAY be short and stout.
-*/
-418 | 
-/** INSUFFICIENT_SPACE_ON_RESOURCE
-* Official Documentation @ https://tools.ietf.org/html/rfc2518#section-10.6
-*
-* The 507 (Insufficient Storage) status code means the method could not be performed on the resource because the server is unable to store the representation needed to successfully complete the request. This condition is considered to be temporary. If the request which received this status code was the result of a user action, the request MUST NOT be repeated until it is requested by a separate user action.
-*/
-419 | 
-/** INSUFFICIENT_STORAGE
-* Official Documentation @ https://tools.ietf.org/html/rfc2518#section-10.6
-*
-* The server has an internal configuration error: the chosen variant resource is configured to engage in transparent content negotiation itself, and is therefore not a proper end point in the negotiation process.
-*/
-507 | 
-/** INTERNAL_SERVER_ERROR
-* Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.6.1
-*
-* The server encountered an unexpected condition that prevented it from fulfilling the request.
-*/
-500 | 
-/** LENGTH_REQUIRED
-* Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.10
-*
-* The server rejected the request because the Content-Length header field is not defined and the server requires it.
-*/
-411 | 
-/** LOCKED
-* Official Documentation @ https://tools.ietf.org/html/rfc2518#section-10.4
-*
-* The resource that is being accessed is locked.
-*/
-423 | 
-/** METHOD_FAILURE
-* @deprecated
-* Official Documentation @ https://tools.ietf.org/rfcdiff?difftype=--hwdiff&url2=draft-ietf-webdav-protocol-06.txt
-*
-* A deprecated response used by the Spring Framework when a method has failed.
-*/
-420 | 
-/** METHOD_NOT_ALLOWED
-* Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.5
-*
-* The request method is known by the server but has been disabled and cannot be used. For example, an API may forbid DELETE-ing a resource. The two mandatory methods, GET and HEAD, must never be disabled and should not return this error code.
-*/
-405 | 
-/** MOVED_PERMANENTLY
-* Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.4.2
-*
-* This response code means that URI of requested resource has been changed. Probably, new URI would be given in the response.
-*/
-301 | 
-/** MOVED_TEMPORARILY
-* Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.4.3
-*
-* This response code means that URI of requested resource has been changed temporarily. New changes in the URI might be made in the future. Therefore, this same URI should be used by the client in future requests.
-*/
-302 | 
-/** MULTI_STATUS
-* Official Documentation @ https://tools.ietf.org/html/rfc2518#section-10.2
-*
-* A Multi-Status response conveys information about multiple resources in situations where multiple status codes might be appropriate.
-*/
-207 | 
-/** MULTIPLE_CHOICES
-* Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.4.1
-*
-* The request has more than one possible responses. User-agent or user should choose one of them. There is no standardized way to choose one of the responses.
-*/
-300 | 
-/** NETWORK_AUTHENTICATION_REQUIRED
-* Official Documentation @ https://tools.ietf.org/html/rfc6585#section-6
-*
-* The 511 status code indicates that the client needs to authenticate to gain network access.
-*/
-511 | 
-/** NO_CONTENT
-* Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.3.5
-*
-* There is no content to send for this request, but the headers may be useful. The user-agent may update its cached headers for this resource with the new ones.
-*/
-204 | 
-/** NON_AUTHORITATIVE_INFORMATION
-* Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.3.4
-*
-* This response code means returned meta-information set is not exact set as available from the origin server, but collected from a local or a third party copy. Except this condition, 200 OK response should be preferred instead of this response.
-*/
-203 | 
-/** NOT_ACCEPTABLE
-* Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.6
-*
-* This response is sent when the web server, after performing server-driven content negotiation, doesn't find any content following the criteria given by the user agent.
-*/
-406 | 
-/** NOT_FOUND
-* Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.4
-*
-* The server can not find requested resource. In the browser, this means the URL is not recognized. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. This response code is probably the most famous one due to its frequent occurrence on the web.
-*/
-404 | 
-/** NOT_IMPLEMENTED
-* Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.6.2
-*
-* The request method is not supported by the server and cannot be handled. The only methods that servers are required to support (and therefore that must not return this code) are GET and HEAD.
-*/
-501 | 
-/** NOT_MODIFIED
-* Official Documentation @ https://tools.ietf.org/html/rfc7232#section-4.1
-*
-* This is used for caching purposes. It is telling to client that response has not been modified. So, client can continue to use same cached version of response.
-*/
-304 | 
-/** OK
-* Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.3.1
-*
-* The request has succeeded. The meaning of a success varies depending on the HTTP method:
-* GET: The resource has been fetched and is transmitted in the message body.
-* HEAD: The entity headers are in the message body.
-* POST: The resource describing the result of the action is transmitted in the message body.
-* TRACE: The message body contains the request message as received by the server
-*/
-200 | 
-/** PARTIAL_CONTENT
-* Official Documentation @ https://tools.ietf.org/html/rfc7233#section-4.1
-*
-* This response code is used because of range header sent by the client to separate download into multiple streams.
-*/
-206 | 
-/** PAYMENT_REQUIRED
-* Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.2
-*
-* This response code is reserved for future use. Initial aim for creating this code was using it for digital payment systems however this is not used currently.
-*/
-402 | 
-/** PERMANENT_REDIRECT
-* Official Documentation @ https://tools.ietf.org/html/rfc7538#section-3
-*
-* This means that the resource is now permanently located at another URI, specified by the Location: HTTP Response header. This has the same semantics as the 301 Moved Permanently HTTP response code, with the exception that the user agent must not change the HTTP method used: if a POST was used in the first request, a POST must be used in the second request.
-*/
-308 | 
-/** PRECONDITION_FAILED
-* Official Documentation @ https://tools.ietf.org/html/rfc7232#section-4.2
-*
-* The client has indicated preconditions in its headers which the server does not meet.
-*/
-412 | 
-/** PRECONDITION_REQUIRED
-* Official Documentation @ https://tools.ietf.org/html/rfc6585#section-3
-*
-* The origin server requires the request to be conditional. Intended to prevent the 'lost update' problem, where a client GETs a resource's state, modifies it, and PUTs it back to the server, when meanwhile a third party has modified the state on the server, leading to a conflict.
-*/
-428 | 
-/** PROCESSING
-* Official Documentation @ https://tools.ietf.org/html/rfc2518#section-10.1
-*
-* This code indicates that the server has received and is processing the request, but no response is available yet.
-*/
-102 | 
-/** PROXY_AUTHENTICATION_REQUIRED
-* Official Documentation @ https://tools.ietf.org/html/rfc7235#section-3.2
-*
-* This is similar to 401 but authentication is needed to be done by a proxy.
-*/
-407 | 
-/** REQUEST_HEADER_FIELDS_TOO_LARGE
-* Official Documentation @ https://tools.ietf.org/html/rfc6585#section-5
-*
-* The server is unwilling to process the request because its header fields are too large. The request MAY be resubmitted after reducing the size of the request header fields.
-*/
-431 | 
-/** REQUEST_TIMEOUT
-* Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.7
-*
-* This response is sent on an idle connection by some servers, even without any previous request by the client. It means that the server would like to shut down this unused connection. This response is used much more since some browsers, like Chrome, Firefox 27+, or IE9, use HTTP pre-connection mechanisms to speed up surfing. Also note that some servers merely shut down the connection without sending this message.
-*/
-408 | 
-/** REQUEST_TOO_LONG
-* Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.11
-*
-* Request entity is larger than limits defined by server; the server might close the connection or return an Retry-After header field.
-*/
-413 | 
-/** REQUEST_URI_TOO_LONG
-* Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.12
-*
-* The URI requested by the client is longer than the server is willing to interpret.
-*/
-414 | 
-/** REQUESTED_RANGE_NOT_SATISFIABLE
-* Official Documentation @ https://tools.ietf.org/html/rfc7233#section-4.4
-*
-* The range specified by the Range header field in the request can't be fulfilled; it's possible that the range is outside the size of the target URI's data.
-*/
-416 | 
-/** RESET_CONTENT
-* Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.3.6
-*
-* This response code is sent after accomplishing request to tell user agent reset document view which sent this request.
-*/
-205 | 
-/** SEE_OTHER
-* Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.4.4
-*
-* Server sent this response to directing client to get requested resource to another URI with an GET request.
-*/
-303 | 
-/** SERVICE_UNAVAILABLE
-* Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.6.4
-*
-* The server is not ready to handle the request. Common causes are a server that is down for maintenance or that is overloaded. Note that together with this response, a user-friendly page explaining the problem should be sent. This responses should be used for temporary conditions and the Retry-After: HTTP header should, if possible, contain the estimated time before the recovery of the service. The webmaster must also take care about the caching-related headers that are sent along with this response, as these temporary condition responses should usually not be cached.
-*/
-503 | 
-/** SWITCHING_PROTOCOLS
-* Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.2.2
-*
-* This code is sent in response to an Upgrade request header by the client, and indicates the protocol the server is switching too.
-*/
-101 | 
-/** TEMPORARY_REDIRECT
-* Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.4.7
-*
-* Server sent this response to directing client to get requested resource to another URI with same method that used prior request. This has the same semantic than the 302 Found HTTP response code, with the exception that the user agent must not change the HTTP method used: if a POST was used in the first request, a POST must be used in the second request.
-*/
-307 | 
-/** TOO_MANY_REQUESTS
-* Official Documentation @ https://tools.ietf.org/html/rfc6585#section-4
-*
-* The user has sent too many requests in a given amount of time ("rate limiting").
-*/
-429 | 
-/** UNAUTHORIZED
-* Official Documentation @ https://tools.ietf.org/html/rfc7235#section-3.1
-*
-* Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.
-*/
-401 | 
-/** UNAVAILABLE_FOR_LEGAL_REASONS
-* Official Documentation @ https://tools.ietf.org/html/rfc7725
-*
-* The user-agent requested a resource that cannot legally be provided, such as a web page censored by a government.
-*/
-451 | 
-/** UNPROCESSABLE_ENTITY
-* Official Documentation @ https://tools.ietf.org/html/rfc2518#section-10.3
-*
-* The request was well-formed but was unable to be followed due to semantic errors.
-*/
-422 | 
-/** UNSUPPORTED_MEDIA_TYPE
-* Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.13
-*
-* The media format of the requested data is not supported by the server, so the server is rejecting the request.
-*/
-415 | 
-/** USE_PROXY
-* @deprecated
-* Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.4.6
-*
-* Was defined in a previous version of the HTTP specification to indicate that a requested response must be accessed by a proxy. It has been deprecated due to security concerns regarding in-band configuration of a proxy.
-*/
-305 | 
-/** MISDIRECTED_REQUEST
-* Official Documentation @ https://datatracker.ietf.org/doc/html/rfc7540#section-9.1.2
-*
-* Defined in the specification of HTTP/2 to indicate that a server is not able to produce a response for the combination of scheme and authority that are included in the request URI.
-*/
-421;
-declare type BaseProblemDocument = {
+/**
+ * ACCEPTED
+ * Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.3.3
+ *
+ * The request has been received but not yet acted upon. It is non-committal, meaning that there is no way in HTTP to later send an asynchronous response indicating the outcome of processing the request. It is intended for cases where another process or server handles the request, or for batch processing.
+ */
+202
+/**
+ * BAD_GATEWAY
+ * Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.6.3
+ *
+ * This error response means that the server, while working as a gateway to get a response needed to handle the request, got an invalid response.
+ */
+ | 502
+/**
+ * BAD_REQUEST
+ * Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.1
+ *
+ * This response means that server could not understand the request due to invalid syntax.
+ */
+ | 400
+/**
+ * CONFLICT
+ * Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.8
+ *
+ * This response is sent when a request conflicts with the current state of the server.
+ */
+ | 409
+/**
+ * CONTINUE
+ * Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.2.1
+ *
+ * This interim response indicates that everything so far is OK and that the client should continue with the request or ignore it if it is already finished.
+ */
+ | 100
+/**
+ * CREATED
+ * Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.3.2
+ *
+ * The request has succeeded and a new resource has been created as a result of it. This is typically the response sent after a PUT request.
+ */
+ | 201
+/**
+ * EXPECTATION_FAILED
+ * Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.14
+ *
+ * This response code means the expectation indicated by the Expect request header field can't be met by the server.
+ */
+ | 417
+/**
+ * FAILED_DEPENDENCY
+ * Official Documentation @ https://tools.ietf.org/html/rfc2518#section-10.5
+ *
+ * The request failed due to failure of a previous request.
+ */
+ | 424
+/**
+ * FORBIDDEN
+ * Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.3
+ *
+ * The client does not have access rights to the content, i.e. they are unauthorized, so server is rejecting to give proper response. Unlike 401, the client's identity is known to the server.
+ */
+ | 403
+/**
+ * GATEWAY_TIMEOUT
+ * Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.6.5
+ *
+ * This error response is given when the server is acting as a gateway and cannot get a response in time.
+ */
+ | 504
+/**
+ * GONE
+ * Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.9
+ *
+ * This response would be sent when the requested content has been permanently deleted from server, with no forwarding address. Clients are expected to remove their caches and links to the resource. The HTTP specification intends this status code to be used for "limited-time, promotional services". APIs should not feel compelled to indicate resources that have been deleted with this status code.
+ */
+ | 410
+/**
+ * HTTP_VERSION_NOT_SUPPORTED
+ * Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.6.6
+ *
+ * The HTTP version used in the request is not supported by the server.
+ */
+ | 505
+/**
+ * IM_A_TEAPOT
+ * Official Documentation @ https://tools.ietf.org/html/rfc2324#section-2.3.2
+ *
+ * Any attempt to brew coffee with a teapot should result in the error code "418 I'm a teapot". The resulting entity body MAY be short and stout.
+ */
+ | 418
+/**
+ * INSUFFICIENT_SPACE_ON_RESOURCE
+ * Official Documentation @ https://tools.ietf.org/html/rfc2518#section-10.6
+ *
+ * The 507 (Insufficient Storage) status code means the method could not be performed on the resource because the server is unable to store the representation needed to successfully complete the request. This condition is considered to be temporary. If the request which received this status code was the result of a user action, the request MUST NOT be repeated until it is requested by a separate user action.
+ */
+ | 419
+/**
+ * INSUFFICIENT_STORAGE
+ * Official Documentation @ https://tools.ietf.org/html/rfc2518#section-10.6
+ *
+ * The server has an internal configuration error: the chosen variant resource is configured to engage in transparent content negotiation itself, and is therefore not a proper end point in the negotiation process.
+ */
+ | 507
+/**
+ * INTERNAL_SERVER_ERROR
+ * Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.6.1
+ *
+ * The server encountered an unexpected condition that prevented it from fulfilling the request.
+ */
+ | 500
+/**
+ * LENGTH_REQUIRED
+ * Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.10
+ *
+ * The server rejected the request because the Content-Length header field is not defined and the server requires it.
+ */
+ | 411
+/**
+ * LOCKED
+ * Official Documentation @ https://tools.ietf.org/html/rfc2518#section-10.4
+ *
+ * The resource that is being accessed is locked.
+ */
+ | 423
+/**
+ * METHOD_FAILURE
+ *
+ * @deprecated
+ * Official Documentation @ https://tools.ietf.org/rfcdiff?difftype=--hwdiff&url2=draft-ietf-webdav-protocol-06.txt
+ *
+ * A deprecated response used by the Spring Framework when a method has failed.
+ */
+ | 420
+/**
+ * METHOD_NOT_ALLOWED
+ * Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.5
+ *
+ * The request method is known by the server but has been disabled and cannot be used. For example, an API may forbid DELETE-ing a resource. The two mandatory methods, GET and HEAD, must never be disabled and should not return this error code.
+ */
+ | 405
+/**
+ * MOVED_PERMANENTLY
+ * Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.4.2
+ *
+ * This response code means that URI of requested resource has been changed. Probably, new URI would be given in the response.
+ */
+ | 301
+/**
+ * MOVED_TEMPORARILY
+ * Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.4.3
+ *
+ * This response code means that URI of requested resource has been changed temporarily. New changes in the URI might be made in the future. Therefore, this same URI should be used by the client in future requests.
+ */
+ | 302
+/**
+ * MULTI_STATUS
+ * Official Documentation @ https://tools.ietf.org/html/rfc2518#section-10.2
+ *
+ * A Multi-Status response conveys information about multiple resources in situations where multiple status codes might be appropriate.
+ */
+ | 207
+/**
+ * MULTIPLE_CHOICES
+ * Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.4.1
+ *
+ * The request has more than one possible responses. User-agent or user should choose one of them. There is no standardized way to choose one of the responses.
+ */
+ | 300
+/**
+ * NETWORK_AUTHENTICATION_REQUIRED
+ * Official Documentation @ https://tools.ietf.org/html/rfc6585#section-6
+ *
+ * The 511 status code indicates that the client needs to authenticate to gain network access.
+ */
+ | 511
+/**
+ * NO_CONTENT
+ * Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.3.5
+ *
+ * There is no content to send for this request, but the headers may be useful. The user-agent may update its cached headers for this resource with the new ones.
+ */
+ | 204
+/**
+ * NON_AUTHORITATIVE_INFORMATION
+ * Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.3.4
+ *
+ * This response code means returned meta-information set is not exact set as available from the origin server, but collected from a local or a third party copy. Except this condition, 200 OK response should be preferred instead of this response.
+ */
+ | 203
+/**
+ * NOT_ACCEPTABLE
+ * Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.6
+ *
+ * This response is sent when the web server, after performing server-driven content negotiation, doesn't find any content following the criteria given by the user agent.
+ */
+ | 406
+/**
+ * NOT_FOUND
+ * Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.4
+ *
+ * The server can not find requested resource. In the browser, this means the URL is not recognized. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. This response code is probably the most famous one due to its frequent occurrence on the web.
+ */
+ | 404
+/**
+ * NOT_IMPLEMENTED
+ * Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.6.2
+ *
+ * The request method is not supported by the server and cannot be handled. The only methods that servers are required to support (and therefore that must not return this code) are GET and HEAD.
+ */
+ | 501
+/**
+ * NOT_MODIFIED
+ * Official Documentation @ https://tools.ietf.org/html/rfc7232#section-4.1
+ *
+ * This is used for caching purposes. It is telling to client that response has not been modified. So, client can continue to use same cached version of response.
+ */
+ | 304
+/**
+ * OK
+ * Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.3.1
+ *
+ * The request has succeeded. The meaning of a success varies depending on the HTTP method:
+ * GET: The resource has been fetched and is transmitted in the message body.
+ * HEAD: The entity headers are in the message body.
+ * POST: The resource describing the result of the action is transmitted in the message body.
+ * TRACE: The message body contains the request message as received by the server
+ */
+ | 200
+/**
+ * PARTIAL_CONTENT
+ * Official Documentation @ https://tools.ietf.org/html/rfc7233#section-4.1
+ *
+ * This response code is used because of range header sent by the client to separate download into multiple streams.
+ */
+ | 206
+/**
+ * PAYMENT_REQUIRED
+ * Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.2
+ *
+ * This response code is reserved for future use. Initial aim for creating this code was using it for digital payment systems however this is not used currently.
+ */
+ | 402
+/**
+ * PERMANENT_REDIRECT
+ * Official Documentation @ https://tools.ietf.org/html/rfc7538#section-3
+ *
+ * This means that the resource is now permanently located at another URI, specified by the Location: HTTP Response header. This has the same semantics as the 301 Moved Permanently HTTP response code, with the exception that the user agent must not change the HTTP method used: if a POST was used in the first request, a POST must be used in the second request.
+ */
+ | 308
+/**
+ * PRECONDITION_FAILED
+ * Official Documentation @ https://tools.ietf.org/html/rfc7232#section-4.2
+ *
+ * The client has indicated preconditions in its headers which the server does not meet.
+ */
+ | 412
+/**
+ * PRECONDITION_REQUIRED
+ * Official Documentation @ https://tools.ietf.org/html/rfc6585#section-3
+ *
+ * The origin server requires the request to be conditional. Intended to prevent the 'lost update' problem, where a client GETs a resource's state, modifies it, and PUTs it back to the server, when meanwhile a third party has modified the state on the server, leading to a conflict.
+ */
+ | 428
+/**
+ * PROCESSING
+ * Official Documentation @ https://tools.ietf.org/html/rfc2518#section-10.1
+ *
+ * This code indicates that the server has received and is processing the request, but no response is available yet.
+ */
+ | 102
+/**
+ * PROXY_AUTHENTICATION_REQUIRED
+ * Official Documentation @ https://tools.ietf.org/html/rfc7235#section-3.2
+ *
+ * This is similar to 401 but authentication is needed to be done by a proxy.
+ */
+ | 407
+/**
+ * REQUEST_HEADER_FIELDS_TOO_LARGE
+ * Official Documentation @ https://tools.ietf.org/html/rfc6585#section-5
+ *
+ * The server is unwilling to process the request because its header fields are too large. The request MAY be resubmitted after reducing the size of the request header fields.
+ */
+ | 431
+/**
+ * REQUEST_TIMEOUT
+ * Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.7
+ *
+ * This response is sent on an idle connection by some servers, even without any previous request by the client. It means that the server would like to shut down this unused connection. This response is used much more since some browsers, like Chrome, Firefox 27+, or IE9, use HTTP pre-connection mechanisms to speed up surfing. Also note that some servers merely shut down the connection without sending this message.
+ */
+ | 408
+/**
+ * REQUEST_TOO_LONG
+ * Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.11
+ *
+ * Request entity is larger than limits defined by server; the server might close the connection or return an Retry-After header field.
+ */
+ | 413
+/**
+ * REQUEST_URI_TOO_LONG
+ * Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.12
+ *
+ * The URI requested by the client is longer than the server is willing to interpret.
+ */
+ | 414
+/**
+ * REQUESTED_RANGE_NOT_SATISFIABLE
+ * Official Documentation @ https://tools.ietf.org/html/rfc7233#section-4.4
+ *
+ * The range specified by the Range header field in the request can't be fulfilled; it's possible that the range is outside the size of the target URI's data.
+ */
+ | 416
+/**
+ * RESET_CONTENT
+ * Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.3.6
+ *
+ * This response code is sent after accomplishing request to tell user agent reset document view which sent this request.
+ */
+ | 205
+/**
+ * SEE_OTHER
+ * Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.4.4
+ *
+ * Server sent this response to directing client to get requested resource to another URI with an GET request.
+ */
+ | 303
+/**
+ * SERVICE_UNAVAILABLE
+ * Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.6.4
+ *
+ * The server is not ready to handle the request. Common causes are a server that is down for maintenance or that is overloaded. Note that together with this response, a user-friendly page explaining the problem should be sent. This responses should be used for temporary conditions and the Retry-After: HTTP header should, if possible, contain the estimated time before the recovery of the service. The webmaster must also take care about the caching-related headers that are sent along with this response, as these temporary condition responses should usually not be cached.
+ */
+ | 503
+/**
+ * SWITCHING_PROTOCOLS
+ * Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.2.2
+ *
+ * This code is sent in response to an Upgrade request header by the client, and indicates the protocol the server is switching too.
+ */
+ | 101
+/**
+ * TEMPORARY_REDIRECT
+ * Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.4.7
+ *
+ * Server sent this response to directing client to get requested resource to another URI with same method that used prior request. This has the same semantic than the 302 Found HTTP response code, with the exception that the user agent must not change the HTTP method used: if a POST was used in the first request, a POST must be used in the second request.
+ */
+ | 307
+/**
+ * TOO_MANY_REQUESTS
+ * Official Documentation @ https://tools.ietf.org/html/rfc6585#section-4
+ *
+ * The user has sent too many requests in a given amount of time ("rate limiting").
+ */
+ | 429
+/**
+ * UNAUTHORIZED
+ * Official Documentation @ https://tools.ietf.org/html/rfc7235#section-3.1
+ *
+ * Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.
+ */
+ | 401
+/**
+ * UNAVAILABLE_FOR_LEGAL_REASONS
+ * Official Documentation @ https://tools.ietf.org/html/rfc7725
+ *
+ * The user-agent requested a resource that cannot legally be provided, such as a web page censored by a government.
+ */
+ | 451
+/**
+ * UNPROCESSABLE_ENTITY
+ * Official Documentation @ https://tools.ietf.org/html/rfc2518#section-10.3
+ *
+ * The request was well-formed but was unable to be followed due to semantic errors.
+ */
+ | 422
+/**
+ * UNSUPPORTED_MEDIA_TYPE
+ * Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.13
+ *
+ * The media format of the requested data is not supported by the server, so the server is rejecting the request.
+ */
+ | 415
+/**
+ * USE_PROXY
+ *
+ * @deprecated
+ * Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.4.6
+ *
+ * Was defined in a previous version of the HTTP specification to indicate that a requested response must be accessed by a proxy. It has been deprecated due to security concerns regarding in-band configuration of a proxy.
+ */
+ | 305
+/**
+ * MISDIRECTED_REQUEST
+ * Official Documentation @ https://datatracker.ietf.org/doc/html/rfc7540#section-9.1.2
+ *
+ * Defined in the specification of HTTP/2 to indicate that a server is not able to produce a response for the combination of scheme and authority that are included in the request URI.
+ */
+ | 421;
+/**
+ * Base class for Problem Documents, which includes the non-extension fields
+ */
+export declare type BaseProblemDocumentProperties = {
+    /**
+     * A URI reference [{@link https://datatracker.ietf.org/doc/html/rfc3986 RFC3986}] that identifies the
+     * problem type.  This specification encourages that, when
+     * dereferenced, it provide human-readable documentation for the
+     * problem type (e.g., using HTML [{@link https://datatracker.ietf.org/doc/html/rfc7807#ref-W3C.REC-html5-20141028 W3C.REC-html5-20141028}]).  When
+     * this member is not present, its value is assumed to be
+     * "about:blank".
+     */
+    type?: string;
+    /**
+     * A short, human-readable summary of the problem
+     * type.  It SHOULD NOT change from occurrence to occurrence of the
+     * problem, except for purposes of localization (e.g., using
+     * proactive content negotiation; see {@link https://datatracker.ietf.org/doc/html/rfc7231#section-3.4 [RFC7231], Section 3.4}).
+     */
+    title?: string;
+    /**
+     * The HTTP status code ({@link https://datatracker.ietf.org/doc/html/rfc7231#section-6 [RFC7231], Section 6})
+     * generated by the origin server for this occurrence of the problem.
+     */
+    status?: StatusCode;
+    /**
+     * A human-readable explanation specific to this occurrence of the problem.
+     */
     detail?: string;
+    /**
+     * A URI reference that identifies the specific
+     * occurrence of the problem.  It may or may not yield further
+     * information if dereferenced.
+     */
     instance?: string;
-    status?: StatusCode;
-    title?: string;
-    type?: string;
 };
-declare type ExtendedProblemDocument = Omit<Record<string, unknown>, keyof BaseProblemDocument> & BaseProblemDocument;
-export declare class ProblemDocument implements ExtendedProblemDocument {
+/**
+ * The Problem Document with extensions
+ *
+ * Note the use of Omit, this allows auto-completion of the base fields
+ */
+export declare type ProblemDocumentProperties = Omit<Record<string, unknown>, keyof BaseProblemDocumentProperties> & BaseProblemDocumentProperties;
+/**
+ *
+ * This class implements RFC7807 "problem detail", a way to carry machine-
+ * readable details of errors in a HTTP response to avoid the need to
+ * define new error response formats for HTTP APIs.
+ *
+ * Official Documentation @ https://datatracker.ietf.org/doc/html/rfc7807
+ *
+ * Consumers MUST use the "type" string as the primary identifier for
+ * the problem type; the "title" string is advisory and included only
+ * for users who are not aware of the semantics of the URI and do not
+ * have the ability to discover them (e.g., offline log analysis).
+ * Consumers SHOULD NOT automatically dereference the type URI.
+ *
+ * The "status" member, if present, is only advisory; it conveys the
+ * HTTP status code used for the convenience of the consumer.
+ * Generators MUST use the same status code in the actual HTTP response,
+ * to assure that generic HTTP software that does not understand this
+ * format still behaves correctly.  See Section 5 for further caveats
+ * regarding its use.
+ *
+ * Consumers can use the status member to determine what the original
+ * status code used by the generator was, in cases where it has been
+ * changed (e.g., by an intermediary or cache), and when message bodies
+ * persist without HTTP information.  Generic HTTP software will still
+ * use the HTTP status code.
+ *
+ * The "detail" member, if present, ought to focus on helping the client
+ * correct the problem, rather than giving debugging information.
+ *
+ * Consumers SHOULD NOT parse the "detail" member for information;
+ * extensions are more suitable and less error-prone ways to obtain such
+ * information.
+ *
+ * Note that both {@link BaseProblemDocumentProperties.type type} and {@link BaseProblemDocumentProperties.instance instance} accept relative URIs; this means
+ * that they must be resolved relative to the document's base URI, as
+ * per {@link https://datatracker.ietf.org/doc/html/rfc3986#section-5 [RFC3986], Section 5}.
+ */
+export declare class ProblemDocument implements ProblemDocumentProperties {
     detail?: string;
     instance?: string;
     status?: StatusCode;
     title?: string;
     type?: string;
     [k: string]: unknown;
-    constructor(data: ExtendedProblemDocument);
+    /**
+     *
+     * construct a new ProblemDocument instance
+     *
+     * @param data properties to assign to the new instance
+     */
+    constructor(data: ProblemDocumentProperties);
 }
 export {};