Field | Type | Required | Description |
---|---|---|---|
content_type |
::String | ✔️ | HTTP response content type for this operation |
status_code |
::Integer | ✔️ | HTTP response status code for this operation |
raw_response |
Faraday::Response | ✔️ | Raw HTTP response; suitable for custom response parsing |
domain_schema |
T.nilable(::OpenApiSDK::Shared::DomainSchema) | ➖ | The domain was created. |
bad_request |
T.nilable(::OpenApiSDK::Shared::BadRequest) | ➖ | The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). |
unauthorized |
T.nilable(::OpenApiSDK::Shared::Unauthorized) | ➖ | Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. |
forbidden |
T.nilable(::OpenApiSDK::Shared::Forbidden) | ➖ | The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401 Unauthorized, the client's identity is known to the server. |
not_found |
T.nilable(::OpenApiSDK::Shared::NotFound) | ➖ | The server cannot find the requested resource. |
conflict |
T.nilable(::OpenApiSDK::Shared::Conflict) | ➖ | This response is sent when a request conflicts with the current state of the server. |
invite_expired |
T.nilable(::OpenApiSDK::Shared::InviteExpired) | ➖ | This response is sent when the requested content has been permanently deleted from server, with no forwarding address. |
unprocessable_entity |
T.nilable(::OpenApiSDK::Shared::UnprocessableEntity) | ➖ | The request was well-formed but was unable to be followed due to semantic errors. |
rate_limit_exceeded |
T.nilable(::OpenApiSDK::Shared::RateLimitExceeded) | ➖ | The user has sent too many requests in a given amount of time ("rate limiting") |
internal_server_error |
T.nilable(::OpenApiSDK::Shared::InternalServerError) | ➖ | The server has encountered a situation it does not know how to handle. |