Contents

# SyncteraRubySdk::Error

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **code** | **String** | An optional “sneak preview” of our future API v1 error responses. This is provided to give integrators a chance to work with our future error codes. Error codes for the same error may change between v0 and v1. | [optional] |
| **detail** | **String** | A human-readable string explaining this particular error.  | [optional] |
| **status** | **Integer** | the HTTP status code for this response | [optional] |
| **title** | **String** | A human-readable string for this general category of error, which corresponds 1-to-1 with error types (`title` is the human-readable version of `type`). There can be multiple distinct titles for the same HTTP status code, and the same `title` can result in many different `detail` strings. This field will be removed in API v1.  | [optional] |
| **type** | **String** | A machine-readable string that identifies the error for programmatic use. This is a URI, i.e. a globally unique identifier. It is _not_ necessarily a URL, so do not expect it to resolve to a web page. You can use this whole string as an error code, or just everything after the last slash. This field will be removed in API v1.  | [optional] |

## Example

```ruby
require 'synctera_ruby_sdk'

instance = SyncteraRubySdk::Error.new(
  code: BAD_REQUEST_BODY,
  detail: missing required fields: first_name, dob,
  status: 400,
  title: Bad Request Body,
  type: https://dev.synctera.com/errors/bad-request-body
)
```

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
synctera_ruby_sdk-1.1.3	docs/Error.md
synctera_ruby_sdk-1.1.2	docs/Error.md
synctera_ruby_sdk-1.1.1	docs/Error.md
synctera_ruby_sdk-1.0.0	docs/Error.md