Class: SyncteraRubySdk::DisclosuresDeprecatedApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DisclosuresDeprecatedApi

Returns a new instance of DisclosuresDeprecatedApi.



19
20
21
 
# File 'lib/synctera_ruby_sdk/api/disclosures_deprecated_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_deprecated_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_disclosure1(customer_id, disclosure1, opts = {}) ⇒ Disclosure1

Create a Disclosure Disclosures to be made to customers

Parameters:

  • customer_id (String) —

    The customer's unique identifier

  • disclosure1 (Disclosure1) —

    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:



29
30
31
32
 
# File 'lib/synctera_ruby_sdk/api/disclosures_deprecated_api.rb', line 29

def create_disclosure1(customer_id, disclosure1, opts = {})
  data, _status_code, _headers = create_disclosure1_with_http_info(customer_id, disclosure1, opts)
  data
end

#create_disclosure1_with_http_info(customer_id, disclosure1, opts = {}) ⇒ Array<(Disclosure1, Integer, Hash)>

Create a Disclosure Disclosures to be made to customers

Parameters:

  • customer_id (String) —

    The customer&#39;s unique identifier

  • disclosure1 (Disclosure1) —

    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<(Disclosure1, Integer, Hash)>) —

    Disclosure1 data, response status code and response headers



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
92
93
94
95
96
97
 
# File 'lib/synctera_ruby_sdk/api/disclosures_deprecated_api.rb', line 41

def create_disclosure1_with_http_info(customer_id, disclosure1, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DisclosuresDeprecatedApi.create_disclosure1 ...'
  end
  # verify the required parameter 'customer_id' is set
  if @api_client.config.client_side_validation && customer_id.nil?
    fail ArgumentError, "Missing the required parameter 'customer_id' when calling DisclosuresDeprecatedApi.create_disclosure1"
  end
  # verify the required parameter 'disclosure1' is set
  if @api_client.config.client_side_validation && disclosure1.nil?
    fail ArgumentError, "Missing the required parameter 'disclosure1' when calling DisclosuresDeprecatedApi.create_disclosure1"
  end
  # resource path
  local_var_path = '/customers/{customer_id}/disclosures'.sub('{' + 'customer_id' + '}', CGI.escape(customer_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'])
  # 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(disclosure1)

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

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

  new_options = opts.merge(
    :operation => :"DisclosuresDeprecatedApi.create_disclosure1",
    :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: DisclosuresDeprecatedApi#create_disclosure1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_disclosures1(customer_id, opts = {}) ⇒ DisclosureResponse

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

Parameters:

  • customer_id (String) —

    The customer&#39;s unique identifier

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) — default: default to 100
  • :page_token (String)

Returns:



106
107
108
109
 
# File 'lib/synctera_ruby_sdk/api/disclosures_deprecated_api.rb', line 106

def list_disclosures1(customer_id, opts = {})
  data, _status_code, _headers = list_disclosures1_with_http_info(customer_id, opts)
  data
end

#list_disclosures1_with_http_info(customer_id, opts = {}) ⇒ Array<(DisclosureResponse, Integer, Hash)>

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

Parameters:

  • customer_id (String) —

    The customer&#39;s unique identifier

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) — default: default to 100
  • :page_token (String)

Returns:

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

    DisclosureResponse data, response status code and response headers



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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/synctera_ruby_sdk/api/disclosures_deprecated_api.rb', line 118

def list_disclosures1_with_http_info(customer_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DisclosuresDeprecatedApi.list_disclosures1 ...'
  end
  # verify the required parameter 'customer_id' is set
  if @api_client.config.client_side_validation && customer_id.nil?
    fail ArgumentError, "Missing the required parameter 'customer_id' when calling DisclosuresDeprecatedApi.list_disclosures1"
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling DisclosuresDeprecatedApi.list_disclosures1, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/customers/{customer_id}/disclosures'.sub('{' + 'customer_id' + '}', CGI.escape(customer_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'page_token'] = opts[:'page_token'] if !opts[:'page_token'].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] || 'DisclosureResponse'

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

  new_options = opts.merge(
    :operation => :"DisclosuresDeprecatedApi.list_disclosures1",
    :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: DisclosuresDeprecatedApi#list_disclosures1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end