Class: SyncteraRubySdk::DisclosuresApi

Inherits:
Object
  • Object
show all
Defined in:
lib/synctera_ruby_sdk/api/disclosures_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DisclosuresApi

Returns a new instance of DisclosuresApi.



19
20
21
 
# File 'lib/synctera_ruby_sdk/api/disclosures_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/synctera_ruby_sdk/api/disclosures_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_disclosure(disclosure, opts = {}) ⇒ Disclosure

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

Parameters:

  • disclosure (Disclosure) —

    Disclosure to create.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :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.

Returns:



28
29
30
31
 
# File 'lib/synctera_ruby_sdk/api/disclosures_api.rb', line 28

def create_disclosure(disclosure, opts = {})
  data, _status_code, _headers = create_disclosure_with_http_info(disclosure, opts)
  data
end

#create_disclosure_with_http_info(disclosure, opts = {}) ⇒ Array<(Disclosure, Integer, Hash)>

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

Parameters:

  • disclosure (Disclosure) —

    Disclosure to create.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :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.

Returns:

  • (Array<(Disclosure, Integer, Hash)>) —

    Disclosure data, response status code and response headers



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/synctera_ruby_sdk/api/disclosures_api.rb', line 39

def create_disclosure_with_http_info(disclosure, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DisclosuresApi.create_disclosure ...'
  end
  # verify the required parameter 'disclosure' is set
  if @api_client.config.client_side_validation && disclosure.nil?
    fail ArgumentError, "Missing the required parameter 'disclosure' when calling DisclosuresApi.create_disclosure"
  end
  # resource path
  local_var_path = '/disclosures'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end
  header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(disclosure)

  # return_type
  return_type = opts[:debug_return_type] || 'Disclosure'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"DisclosuresApi.create_disclosure",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DisclosuresApi#create_disclosure\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_disclosure(disclosure_id, opts = {}) ⇒ Disclosure

Get disclosure Get disclosure by ID.

Parameters:

  • disclosure_id (String) —

    The unique identifier for the disclosure.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



98
99
100
101
 
# File 'lib/synctera_ruby_sdk/api/disclosures_api.rb', line 98

def get_disclosure(disclosure_id, opts = {})
  data, _status_code, _headers = get_disclosure_with_http_info(disclosure_id, opts)
  data
end

#get_disclosure_with_http_info(disclosure_id, opts = {}) ⇒ Array<(Disclosure, Integer, Hash)>

Get disclosure Get disclosure by ID.

Parameters:

  • disclosure_id (String) —

    The unique identifier for the disclosure.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Disclosure, Integer, Hash)>) —

    Disclosure data, response status code and response headers



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/synctera_ruby_sdk/api/disclosures_api.rb', line 108

def get_disclosure_with_http_info(disclosure_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DisclosuresApi.get_disclosure ...'
  end
  # verify the required parameter 'disclosure_id' is set
  if @api_client.config.client_side_validation && disclosure_id.nil?
    fail ArgumentError, "Missing the required parameter 'disclosure_id' when calling DisclosuresApi.get_disclosure"
  end
  # resource path
  local_var_path = '/disclosures/{disclosure_id}'.sub('{' + 'disclosure_id' + '}', CGI.escape(disclosure_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Disclosure'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"DisclosuresApi.get_disclosure",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DisclosuresApi#get_disclosure\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_disclosures(opts = {}) ⇒ DisclosureList

List disclosures Retrieves paginated list of disclosures associated with the authorized requester.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :id (Array<String>) —

    Unique resource identifier

  • :person_id (Array<String>) —

    Unique identifier for the person. Multiple IDs can be provided as a comma-separated list.

  • :business_id (Array<String>) —

    Unique identifier for the business. Multiple IDs can be provided as a comma-separated list.

  • :limit (Integer) — default: default to 100
  • :page_token (String)
  • :acknowledging_person_id (Array<String>) —

    Return only disclosures that have the specified acknowledging_person_id. Multiple IDs can be provided as a comma-separated list.

Returns:



166
167
168
169
 
# File 'lib/synctera_ruby_sdk/api/disclosures_api.rb', line 166

def list_disclosures(opts = {})
  data, _status_code, _headers = list_disclosures_with_http_info(opts)
  data
end

#list_disclosures_with_http_info(opts = {}) ⇒ Array<(DisclosureList, Integer, Hash)>

List disclosures Retrieves paginated list of disclosures associated with the authorized requester.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :id (Array<String>) —

    Unique resource identifier

  • :person_id (Array<String>) —

    Unique identifier for the person. Multiple IDs can be provided as a comma-separated list.

  • :business_id (Array<String>) —

    Unique identifier for the business. Multiple IDs can be provided as a comma-separated list.

  • :limit (Integer) — default: default to 100
  • :page_token (String)
  • :acknowledging_person_id (Array<String>) —

    Return only disclosures that have the specified acknowledging_person_id. Multiple IDs can be provided as a comma-separated list.

Returns:

  • (Array<(DisclosureList, Integer, Hash)>) —

    DisclosureList data, response status code and response headers



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/synctera_ruby_sdk/api/disclosures_api.rb', line 181

def list_disclosures_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DisclosuresApi.list_disclosures ...'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling DisclosuresApi.list_disclosures, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/disclosures'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :csv) if !opts[:'id'].nil?
  query_params[:'person_id'] = @api_client.build_collection_param(opts[:'person_id'], :csv) if !opts[:'person_id'].nil?
  query_params[:'business_id'] = @api_client.build_collection_param(opts[:'business_id'], :csv) if !opts[:'business_id'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'page_token'] = opts[:'page_token'] if !opts[:'page_token'].nil?
  query_params[:'acknowledging_person_id'] = @api_client.build_collection_param(opts[:'acknowledging_person_id'], :csv) if !opts[:'acknowledging_person_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'DisclosureList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"DisclosuresApi.list_disclosures",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DisclosuresApi#list_disclosures\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end