# SyncteraRubySdk::DisclosuresApi

All URIs are relative to *https://api.synctera.com/v0*

| Method | HTTP request | Description |
| ------ | ------------ | ----------- |
| [**create_disclosure**](DisclosuresApi.md#create_disclosure) | **POST** /disclosures | Create disclosure record |
| [**get_disclosure**](DisclosuresApi.md#get_disclosure) | **GET** /disclosures/{disclosure_id} | Get disclosure |
| [**list_disclosures**](DisclosuresApi.md#list_disclosures) | **GET** /disclosures | List disclosures |


## create_disclosure

> <Disclosure> create_disclosure(disclosure, opts)

Create disclosure record

Record the fact that a regulatory document was disclosed to a customer.

### Examples

```ruby
require 'time'
require 'synctera_ruby_sdk'
# setup authorization
SyncteraRubySdk.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = SyncteraRubySdk::DisclosuresApi.new
disclosure = SyncteraRubySdk::Disclosure.new({disclosure_date: Time.parse('2010-05-06T12:23:34.321Z'), event_type: 'DISPLAYED', type: SyncteraRubySdk::DisclosureType::ACH_AUTHORIZATION, version: '1.0'}) # Disclosure | Disclosure to create.
opts = {
  idempotency_key: '7d943c51-e4ff-4e57-9558-08cab6b963c7' # String | An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.
}

begin
  # Create disclosure record
  result = api_instance.create_disclosure(disclosure, opts)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling DisclosuresApi->create_disclosure: #{e}"
end
```

#### Using the create_disclosure_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(<Disclosure>, Integer, Hash)> create_disclosure_with_http_info(disclosure, opts)

```ruby
begin
  # Create disclosure record
  data, status_code, headers = api_instance.create_disclosure_with_http_info(disclosure, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Disclosure>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling DisclosuresApi->create_disclosure_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **disclosure** | [**Disclosure**](Disclosure.md) | Disclosure to create. |  |
| **idempotency_key** | **String** | An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry. | [optional] |

### Return type

[**Disclosure**](Disclosure.md)

### Authorization

[bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json, application/problem+json


## get_disclosure

> <Disclosure> get_disclosure(disclosure_id)

Get disclosure

Get disclosure by ID.

### Examples

```ruby
require 'time'
require 'synctera_ruby_sdk'
# setup authorization
SyncteraRubySdk.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = SyncteraRubySdk::DisclosuresApi.new
disclosure_id = '7d943c51-e4ff-4e57-9558-08cab6b963c7' # String | The unique identifier for the disclosure.

begin
  # Get disclosure
  result = api_instance.get_disclosure(disclosure_id)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling DisclosuresApi->get_disclosure: #{e}"
end
```

#### Using the get_disclosure_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(<Disclosure>, Integer, Hash)> get_disclosure_with_http_info(disclosure_id)

```ruby
begin
  # Get disclosure
  data, status_code, headers = api_instance.get_disclosure_with_http_info(disclosure_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Disclosure>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling DisclosuresApi->get_disclosure_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **disclosure_id** | **String** | The unique identifier for the disclosure. |  |

### Return type

[**Disclosure**](Disclosure.md)

### Authorization

[bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/problem+json


## list_disclosures

> <DisclosureList> list_disclosures(opts)

List disclosures

Retrieves paginated list of disclosures associated with the authorized requester.

### Examples

```ruby
require 'time'
require 'synctera_ruby_sdk'
# setup authorization
SyncteraRubySdk.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = SyncteraRubySdk::DisclosuresApi.new
opts = {
  id: ['7d943c51-e4ff-4e57-9558-08cab6b963c7'], # Array<String> | Unique resource identifier
  person_id: ['inner_example'], # Array<String> | Unique identifier for the person. Multiple IDs can be provided as a comma-separated list. 
  business_id: ['inner_example'], # Array<String> | Unique identifier for the business. Multiple IDs can be provided as a comma-separated list. 
  limit: 100, # Integer | 
  page_token: 'a8937a0d', # String | 
  acknowledging_person_id: ['inner_example'] # Array<String> | Return only disclosures that have the specified acknowledging_person_id. Multiple IDs can be provided as a comma-separated list. 
}

begin
  # List disclosures
  result = api_instance.list_disclosures(opts)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling DisclosuresApi->list_disclosures: #{e}"
end
```

#### Using the list_disclosures_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(<DisclosureList>, Integer, Hash)> list_disclosures_with_http_info(opts)

```ruby
begin
  # List disclosures
  data, status_code, headers = api_instance.list_disclosures_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <DisclosureList>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling DisclosuresApi->list_disclosures_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **id** | [**Array&lt;String&gt;**](String.md) | Unique resource identifier | [optional] |
| **person_id** | [**Array&lt;String&gt;**](String.md) | Unique identifier for the person. Multiple IDs can be provided as a comma-separated list.  | [optional] |
| **business_id** | [**Array&lt;String&gt;**](String.md) | Unique identifier for the business. Multiple IDs can be provided as a comma-separated list.  | [optional] |
| **limit** | **Integer** |  | [optional][default to 100] |
| **page_token** | **String** |  | [optional] |
| **acknowledging_person_id** | [**Array&lt;String&gt;**](String.md) | Return only disclosures that have the specified acknowledging_person_id. Multiple IDs can be provided as a comma-separated list.  | [optional] |

### Return type

[**DisclosureList**](DisclosureList.md)

### Authorization

[bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/problem+json